Download the PHP package resumex/sdk without Composer
On this page you can find all versions of the php package resumex/sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package sdk
ResumeX PHP SDK
Official PHP SDK for ResumeX API - AI-powered CV generation platform.
⚠️ Breaking Changes in v2.0.0
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 - Complete guide with examples and helper functions
📋 CHANGELOG - Full list of changes
Requirements
- PHP 8.1 or higher
- Laravel 10.x or 11.x (for Laravel integration)
- Guzzle HTTP Client
Installation
Via Composer (Recommended)
Local Development (from this repository)
Add to your composer.json:
Then run:
Configuration
Laravel Auto-Discovery
The package will automatically register its service provider and facade.
Publish Config File
Environment Variables
Add to your .env file:
Usage
Using the Facade (Recommended for Laravel)
Japanese CV (professional-grid template)
For Japanese CVs (履歴書・職務経歴書), use the professional-grid template:
Field Reference
Required Fields (All Templates)
| Field | Type | Description |
|---|---|---|
userId |
string | Unique user ID in your system |
templateId |
string | classic, basic, two-column-modern, or professional-grid |
email |
string | User's email address |
Standard CV Fields (classic, basic, two-column-modern)
| Field | Type | Description |
|---|---|---|
firstName |
string | First name |
lastName |
string | Last name |
phoneNumber |
string | Phone number |
location |
string | City/Country |
linkedinUrl |
string | LinkedIn profile URL |
githubUrl |
string | GitHub profile URL |
portfolioUrl |
string | Portfolio URL |
professionalSummary |
string | Summary or objective |
workExperience |
array | Work experience entries |
education |
array | Education entries |
skills |
array | Skills grouped by category |
certifications |
array | Certifications list |
projects |
array | Project entries |
awards |
array | Awards and achievements |
Date Field Structure (workExperience, education, projects, additionalInformation)
All array items in workExperience, education, projects, and additionalInformation now use this structured date format:
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
startDate |
string | Yes | Start date in MM/YYYY or YYYY format | '01/2020' |
endDate |
string|null | No | End date in MM/YYYY or YYYY format, null if current | '12/2023' or null |
isPresent |
boolean | Yes | true if currently ongoing, false otherwise | true or false |
Examples:
Japanese CV Fields (professional-grid)
Top-level fields:
| Field | Type | Description |
|---|---|---|
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 |
string | Photo URL |
workExperience[] |
array | 職歴 (simple format for 履歴書) |
education[] |
array | 学歴 (simple format for 履歴書) |
webCv object (Japanese-specific fields):
| Field | Type | Description |
|---|---|---|
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 |
string | 0=在職中, 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
Standalone Usage (Without Laravel)
API Reference
CV Resource
Partner Resource
Templates Resource
Error Handling
Complete Integration Example
Controller
Routes
Frontend Integration (Blade/Inertia)
Testing
Sandbox Environment
Use sandbox mode for testing:
Or per-request:
Mock in Tests
Support
- Documentation: https://docs.resumex.com
- Partner Dashboard: https://partners.resumex.com
- Support Email: [email protected]
- GitHub Issues: https://github.com/resumex/sdk-php/issues
License
MIT License. See LICENSE for details.