PHPackages                             resumex/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. resumex/sdk

ActiveLibrary[API Development](/categories/api)

resumex/sdk
===========

Official PHP SDK for ResumeX API - AI-powered CV generation platform

v2.0.2(4mo ago)0341↓44.9%MITPHPPHP ^8.1

Since Feb 10Pushed 4mo agoCompare

[ Source](https://github.com/votien1235/resumex-sdk-php)[ Packagist](https://packagist.org/packages/resumex/sdk)[ Docs](https://github.com/votien1235/resumex-sdk-php)[ RSS](/packages/resumex-sdk/feed)WikiDiscussions main Synced 2d ago

READMEChangelogDependencies (4)Versions (8)Used By (0)

ResumeX PHP SDK
===============

[](#resumex-php-sdk)

Official PHP SDK for ResumeX API - AI-powered CV generation platform.

⚠️ Breaking Changes in v2.0.0
-----------------------------

[](#️-breaking-changes-in-v200)

**Date field structure has changed for `workExperience`, `education`, `projects`, and `additionalInformation`.**

- **Before**: `'date' => 'Jan 2020 - Present'` (free-text string)
- **After**: Three structured fields:
    - `'startDate' => '01/2020'` (required, format: YYYY-MM or YYYY)
    - `'endDate' => null` (optional, null if ongoing)
    - `'isPresent' => true` (required, true if currently ongoing)

**📖 [Migration Guide](MIGRATION_V2.md)** - Complete guide with examples and helper functions
**📋 [CHANGELOG](CHANGELOG.md)** - Full list of changes

Requirements
------------

[](#requirements)

- PHP 8.1 or higher
- Laravel 10.x or 11.x (for Laravel integration)
- Guzzle HTTP Client

Installation
------------

[](#installation)

### Via Composer (Recommended)

[](#via-composer-recommended)

```
composer require resumex/sdk
```

### Local Development (from this repository)

[](#local-development-from-this-repository)

Add to your `composer.json`:

```
{
  "repositories": [
    {
      "type": "path",
      "url": "../packages/resumex-sdk-php"
    }
  ],
  "require": {
    "resumex/sdk": "*"
  }
}
```

Then run:

```
composer update resumex/sdk
```

Configuration
-------------

[](#configuration)

### Laravel Auto-Discovery

[](#laravel-auto-discovery)

The package will automatically register its service provider and facade.

### Publish Config File

[](#publish-config-file)

```
php artisan vendor:publish --tag=resumex-config
```

### Environment Variables

[](#environment-variables)

Add to your `.env` file:

```
RESUMEX_API_KEY=rx_pub_your_api_key
RESUMEX_API_SECRET=your_api_secret
RESUMEX_ENVIRONMENT=production
```

Usage
-----

[](#usage)

### Using the Facade (Recommended for Laravel)

[](#using-the-facade-recommended-for-laravel)

```
use ResumeX\Facades\ResumeX;

// Generate a CV (Standard templates: classic, basic, two-column-modern)
$cv = ResumeX::cv()->generate([
    'userId' => 'user_123',
    'templateId' => 'classic',
    'email' => 'user@example.com',
    'firstName' => 'NGUYEN VAN',
    'lastName' => 'A',
    'phoneNumber' => '0123-456-789',
    'location' => 'Japan',
    'linkedinUrl' => 'https://linkedin.com/in/username',
    'githubUrl' => 'https://github.com/username',
    'professionalSummary' => 'Senior Software Engineer with 5+ years experience...',
    'workExperience' => [
        [
            'company' => 'ABC Tech Company',
            'position' => 'Senior Software Engineer',
            'location' => 'Tokyo',
            'startDate' => '01/2020',
            'endDate' => null,
            'isPresent' => true,
            'description' => ['Led development of microservices architecture...'],
            'technologies' => ['PHP', 'Laravel', 'React'],
        ],
    ],
    'education' => [
        [
            'school' => 'University of Technology',
            'degree' => 'Bachelor of Computer Science',
            'location' => 'Ho Chi Minh',
            'startDate' => '2013-09',
            'endDate' => '2017-06',
            'isPresent' => false,
        ],
    ],
    'skills' => [
        ['category' => 'Backend', 'items' => ['PHP', 'Laravel', 'Node.js']],
        ['category' => 'Frontend', 'items' => ['React', 'Vue.js', 'TypeScript']],
    ],
    // Optional: Projects
    'projects' => [
        [
            'name' => 'E-commerce Platform',
            'description' => ['Built scalable microservices architecture', 'Handled 10k+ daily transactions'],
            'startDate' => '01/2024',
            'endDate' => '12/2024',
            'isPresent' => false,
            'technologies' => ['Laravel', 'React', 'AWS', 'Docker'],
            'url' => 'https://project-demo.com',
        ],
    ],
    // Optional: Additional Information (Certifications, Awards, Publications, etc.)
    'additionalInformation' => [
        [
            'title' => 'Certifications',
            'items' => [
                [
                    'name' => 'AWS Certified Solutions Architect',
                    'organization' => 'Amazon Web Services',
                    'startDate' => '03/2024',
                    'endDate' => null,
                    'isPresent' => false,
                    'description' => 'Professional level certification',
                ],
                [
                    'name' => 'Laravel Certified Developer',
                    'organization' => 'Laravel',
                    'startDate' => '06/2023',
                    'endDate' => null,
                    'isPresent' => false,
                ],
            ],
        ],
        [
            'title' => 'Publications',
            'items' => [
                [
                    'name' => 'Building Scalable APIs with Laravel',
                    'organization' => 'Medium',
                    'startDate' => '11/2023',
                    'endDate' => null,
                    'isPresent' => false,
                    'description' => 'Technical article with 5k+ views',
                ],
            ],
        ],
    ],
    'preferences' => [
        'language' => 'en',
    ],
]);

// Get the editor URL
$editorUrl = $cv['editorUrl'];

// Redirect user or embed in iframe
return redirect($editorUrl);
```

### Japanese CV (professional-grid template)

[](#japanese-cv-professional-grid-template)

For Japanese CVs (履歴書・職務経歴書), use the `professional-grid` template:

```
use ResumeX\Facades\ResumeX;

$cv = ResumeX::cv()->generate([
    // ============================================
    // Required fields (top-level)
    // ============================================
    'userId' => 'user_123',
    'templateId' => 'professional-grid',
    'email' => 'user@example.com',

    // ============================================
    // Basic Info (top-level for Japanese CV)
    // ============================================
    'firstName' => '太郎',
    'lastName' => '山田',
    'firstNameKatana' => 'タロウ',
    'lastNameKatana' => 'ヤマダ',
    'phoneNumber' => '090-1234-5678',
    'postCode' => '100-0001',
    'location' => '東京都千代田区丸の内1-1-1',

    // Birth Date (split into year, month, day)
    'birthYear' => '1990',
    'birthMonth' => '5',
    'birthDay' => '15',
    'gender' => 'male',   // 'male' | 'female' | 'other'

    // Profile Photo
    'profilePhoto' => 'https://example.com/photo.jpg',

    // ============================================
    // Standard CV sections (if you have them)
    // ============================================
    'workExperience' => [
        [
            'company' => '株式会社ABC',
            'position' => 'システムエンジニア',
            'location' => '東京',
            'startDate' => '04/2020',
            'endDate' => null,
            'isPresent' => true,
            'description' => ['Webアプリケーションの設計・開発'],
            'technologies' => ['PHP', 'Laravel', 'React'],
        ],
    ],
    'education' => [
        [
            'school' => '東京大学',
            'degree' => '学士',
            'field' => '情報工学',
            'location' => '東京',
            'startDate' => '2012-04',
            'endDate' => '2016-03',
            'isPresent' => false,
            'gpa' => '',
            'achievements' => [],
        ],
    ],
    'skills' => [],

    // ============================================
    // Japanese CV specific fields (webCv)
    // ============================================
    'webCv' => [
        // Qualifications list (資格一覧)
        'qualificationList' => [
            ['date' => '2018年6月', 'qualification_name' => '普通自動車第一種運転免許'],
            ['date' => '2019年12月', 'qualification_name' => 'TOEIC 850点'],
        ],

        // Detailed work experience for 職務経歴書
        'cv_work_experience' => [
            [
                'company_name' => '株式会社○○',
                'business_description' => 'Webサービス開発',
                'capital' => '1000万円',
                'employee_number' => '50',
                'classification' => '1',  // 1=正社員
                'job_type' => 'エンジニア',
                'job_detail' => 'システム開発・保守',
                'sales' => '5億円',
                'retirement' => '0',  // 0=在職中, 1=退職済み
                'affiliation_period_year' => '2020',
                'affiliation_period_month' => '4',
                'affiliation_period_day' => '1',
                'affiliation_period_end_year' => '',
                'affiliation_period_end_month' => '',
                'affiliation_period_end_day' => '',
            ],
        ],

        // Japanese CV text sections
        'applying_info' => '御社の先進的な技術と企業文化に魅力を感じ...',
        'experience_info' => '私の強みはチームワークとコミュニケーション能力です...',
        'personal_info' => '特になし',
        'cv_job_summary' => 'IT業界で10年以上の経験を持つエンジニア',
        'cv_experience_skill_knowledge' => 'PHP, Laravel, React, AWS',
        'cv_qualifications_held' => '普通自動車免許、TOEIC 850点',
        'cv_self_promotion' => '新しい技術への学習意欲が高く...',

        // Family info
        'spouse' => 1,  // 0=なし, 1=あり
        'spouse_support' => 0,  // 0=なし, 1=あり
        'commuting_time' => '45分',
    ],

    'preferences' => [
        'language' => 'ja',
    ],
]);
```

### Field Reference

[](#field-reference)

#### Required Fields (All Templates)

[](#required-fields-all-templates)

FieldTypeDescription`userId`stringUnique user ID in your system`templateId`string`classic`, `basic`, `two-column-modern`, or `professional-grid``email`stringUser's email address#### Standard CV Fields (classic, basic, two-column-modern)

[](#standard-cv-fields-classic-basic-two-column-modern)

FieldTypeDescription`firstName`stringFirst name`lastName`stringLast name`phoneNumber`stringPhone number`location`stringCity/Country`linkedinUrl`stringLinkedIn profile URL`githubUrl`stringGitHub profile URL`portfolioUrl`stringPortfolio URL`professionalSummary`stringSummary or objective`workExperience`arrayWork experience entries`education`arrayEducation entries`skills`arraySkills grouped by category`certifications`arrayCertifications list`projects`arrayProject entries`awards`arrayAwards and achievements#### Date Field Structure (workExperience, education, projects, additionalInformation)

[](#date-field-structure-workexperience-education-projects-additionalinformation)

All array items in `workExperience`, `education`, `projects`, and `additionalInformation` now use this structured date format:

FieldTypeRequiredDescriptionExample`startDate`stringYesStart date in MM/YYYY or YYYY format`'01/2020'``endDate`string|nullNoEnd date in MM/YYYY or YYYY format, null if current`'12/2023'` or `null``isPresent`booleanYestrue if currently ongoing, false otherwise`true` or `false`**Examples:**

```
// Current position
[
    'company' => 'ABC Corp',
    'position' => 'Senior Engineer',
    'startDate' => '01/2020',
    'endDate' => null,
    'isPresent' => true,
    // ...
}

// Past position
[
    'company' => 'XYZ Inc',
    'position' => 'Engineer',
    'startDate' => '2018-03',
    'endDate' => '2019-12',
    'isPresent' => false,
    // ...
]

// Education (completed)
[
    'school' => 'University of Tokyo',
    'degree' => 'Bachelor of Science',
    'startDate' => '2014-04',
    'endDate' => '2018-03',
    'isPresent' => false,
    // ...
]

// Project (ongoing)
[
    'name' => 'E-commerce Platform',
    'startDate' => '06/2025',
    'endDate' => null,
    'isPresent' => true,
    'description' => ['Building scalable platform...'],
    // ...
]
```

#### Japanese CV Fields (professional-grid)

[](#japanese-cv-fields-professional-grid)

**Top-level fields:**

FieldTypeDescription`firstName`string名 (First name in kanji)`lastName`string姓 (Last name in kanji)`firstNameKatana`stringふりがな (First name reading)`lastNameKatana`stringふりがな (Last name reading)`phoneNumber`string電話番号`postCode`string郵便番号`location`string住所 (Full address)`birthYear`string生年月日 - 年`birthMonth`string生年月日 - 月`birthDay`string生年月日 - 日`gender`string性別: `male`, `female`, `other``profilePhoto`stringPhoto URL`workExperience[]`array職歴 (simple format for 履歴書)`education[]`array学歴 (simple format for 履歴書)**webCv object (Japanese-specific fields):**

FieldTypeDescription`webCv.prefecture`string都道府県 (e.g., "東京都")`webCv.municipality`string市区町村 (e.g., "千代田区")`webCv.address_after`string以降の住所 (丁目・番地・建物名など)`webCv.qualificationList[]`array資格一覧 (Licenses & Qualifications)`webCv.qualificationList[].date`string取得年月 (e.g., "2018年6月")`webCv.qualificationList[].qualification_name`string資格名`webCv.cv_work_experience[]`array職務経歴詳細 (Detailed work history)`webCv.cv_work_experience[].company_name`string会社名`webCv.cv_work_experience[].business_description`string事業内容`webCv.cv_work_experience[].capital`string資本金`webCv.cv_work_experience[].employee_number`string従業員数`webCv.cv_work_experience[].classification`string雇用形態 (1=正社員, etc.)`webCv.cv_work_experience[].job_type`string職種`webCv.cv_work_experience[].job_detail`string職務内容`webCv.cv_work_experience[].sales`string売上高`webCv.cv_work_experience[].retirement`string0=在職中, 1=退職済み`webCv.cv_work_experience[].affiliation_period_year`string入社年`webCv.cv_work_experience[].affiliation_period_month`string入社月`webCv.cv_work_experience[].affiliation_period_day`string入社日`webCv.applying_info`string志望動機`webCv.experience_info`string自己PR・特技・長所など`webCv.personal_info`string本人希望記入欄`webCv.cv_job_summary`string職務要約`webCv.cv_experience_skill_knowledge`string活かせる経験・スキル・知識`webCv.cv_qualifications_held`string保有資格`webCv.cv_self_promotion`string自己PR`webCv.spouse`int配偶者: 0=なし, 1=あり`webCv.spouse_support`int配偶者の扶養義務: 0=なし, 1=あり`webCv.commuting_time`string通勤時間### Using Dependency Injection

[](#using-dependency-injection)

```
use ResumeX\Client;

class CVController extends Controller
{
    public function __construct(
        protected Client $resumex
    ) {}

    public function generate(Request $request)
    {
        $cv = $this->resumex->cv()->generate([
            'userId' => (string) $request->user()->id,
            'templateId' => $request->input('templateId', 'classic'),
            'email' => $request->user()->email,
            'firstName' => $request->input('firstName'),
            'lastName' => $request->input('lastName'),
            'workExperience' => $request->input('workExperience', []),
            // ...
        ]);

        return response()->json([
            'cvId' => $cv['cvId'],
            'editorUrl' => $cv['editorUrl'],
        ]);
    }
}
```

### Standalone Usage (Without Laravel)

[](#standalone-usage-without-laravel)

```
use ResumeX\Client;

$client = new Client([
    'api_key' => 'rx_pub_your_api_key',
    'api_secret' => 'your_api_secret',
    'environment' => 'production', // or 'sandbox'
]);

// Generate CV
$cv = $client->cv()->generate([...]);

// Get CV details
$cvDetails = $client->cv()->get($cv['cvId']);

// Get quota
$quota = $client->partner()->getQuota();
```

API Reference
-------------

[](#api-reference)

### CV Resource

[](#cv-resource)

```
// Generate new CV
$cv = ResumeX::cv()->generate([...]);

// Get CV details
$cv = ResumeX::cv()->get('cv_xyz789');

// Update existing CV (same structure as generate())
$updatedCv = ResumeX::cv()->update('cv_xyz789', [
    'firstName' => 'NGUYEN VAN',
    'lastName' => 'B',
    'phoneNumber' => '0987-654-321',
    'location' => 'Tokyo, Japan',
    'professionalSummary' => 'Updated summary...',
    'workExperience' => [
        [
            'company' => 'New Company',
            'position' => 'Lead Engineer',
            'location' => 'Tokyo',
            'startDate' => '01/2026',
            'endDate' => null,
            'isPresent' => true,
            'description' => ['Leading team of 5...'],
        ],
    ],
    // Or for Japanese CV:
    'webCv' => [
        'lastName' => '山田',
        'firstName' => '太郎',
        'careerHistory' => [
            ['date' => '2015年4月', 'event' => '○○株式会社 入社'],
            ['date' => '2020年3月', 'event' => '○○株式会社 退社'],
        ],
        'selfPr' => '更新された自己PR...',
    ],
]);

// Enhance CV with AI
$enhanced = ResumeX::cv()->enhance('cv_xyz789', [
    'sections' => ['summary', 'experience'],
    'tone' => 'professional',
    'atsOptimization' => true,
]);

// Delete CV
ResumeX::cv()->delete('cv_xyz789');
```

### Partner Resource

[](#partner-resource)

```
// Get quota information
$quota = ResumeX::partner()->getQuota();

// Get usage statistics
$usage = ResumeX::partner()->getUsage('current_month');

// Get analytics dashboard
$dashboard = ResumeX::partner()->getDashboard('last_30_days');
```

### Templates Resource

[](#templates-resource)

```
// List all templates
$templates = ResumeX::templates()->list([
    'category' => 'tech',
    'language' => 'vi',
]);

// Get template details
$template = ResumeX::templates()->get('modern-01');
```

Error Handling
--------------

[](#error-handling)

```
use ResumeX\Exceptions\ResumeXException;
use ResumeX\Facades\ResumeX;

try {
    $cv = ResumeX::cv()->generate([...]);
} catch (ResumeXException $e) {
    // Get error details
    $message = $e->getMessage();
    $errorCode = $e->getErrorCode();
    $statusCode = $e->getStatusCode();

    // Check error type
    if ($e->isRateLimitError()) {
        // Handle rate limiting - wait and retry
    } elseif ($e->isAuthenticationError()) {
        // Invalid API credentials
    } elseif ($e->isValidationError()) {
        // Get validation errors
        $errors = $e->getErrors();
    }

    Log::error('ResumeX API Error', [
        'message' => $message,
        'code' => $errorCode,
        'status' => $statusCode,
    ]);
}
```

Complete Integration Example
----------------------------

[](#complete-integration-example)

### Controller

[](#controller)

```