carerix / cxrest-client
客户端库,用于轻松访问 Carerix REST API
2.3.0
2023-11-02 10:54 UTC
Requires
- ext-curl: *
- ext-json: *
- ext-libxml: *
- ext-simplexml: *
- adbario/php-dot-notation: ^3.3
- guzzlehttp/guzzle: ^7.0
Requires (Dev)
- ext-dom: *
- ext-xmlwriter: *
- nette/php-generator: ^3.4
- pdepend/pdepend: ^2.7
- phpmd/phpmd: ^2.8
- phpunit/phpunit: ^8.5
- squizlabs/php_codesniffer: ^3.5
- symfony/var-dumper: ^6.3
- zf1/zend-console-getopt: ~1.12
README
通过 RESTful API 访问您的 Carerix 应用程序的客户库 (https://api.carerix.com)
安装
推荐方式是使用 composer 安装库
$ composer require carerx/cxrest-client
基本用法
引导
use Carerix\Api\Rest\Client; use Carerix\Api\Rest\Manager; use Carerix\Api\Rest\Entity; $client = new Client(); $manager = new Manager($client); $manager->autoDiscoverEntities(); $manager->setUsername(CUSTOMER_NAME); $manager->setPassword(API_TOKEN); Entity::setManager($manager);
使用(正确引导实体管理器后)
use Carerix\Api\Rest\Entity\CREmployee; use Carerix\Api\Rest\Entity\CRUser; // get user by ID $user = CRUser::find(125); // apply for a job $params = array('x-cx-pub' => PUBLICATION_ID_GOES_HERE); $employee = new CREmployee(); $employee ->setFirstName('John') ->setLastName('Smith'); $employee->apply($params);
资源
- http://development.wiki.carerix.com/cxwiki/doku.php?id=cxrest - RESTful API 描述
- http://development.wiki.carerix.com/cxwiki/doku.php?id=cxrest_api_methods - Carerix RESTful API 提供的方法的详细描述
- http://development.wiki.carerix.com/cxwiki/doku.php?id=cxrest_api_client - 此客户端库的详细描述和示例
- http://development.wiki.carerix.com/cxwiki/doku.php?id=xml - 所有开发者,可以使用 Carerix RESTful API 的 XML 包的示例
要访问这些资源,您必须申请合作伙伴开发者帐户。
许可证
本项目的所有内容均受 MIT 许可证的许可。有关详细信息,请参阅 LICENSE 文件。
致谢
本项目高度受 Doctrine (www.doctrine-project.org) 实现 ActiveRecord 模式和 Doctrine REST API 客户端的启发。