carerix/cxrest-client

客户端库,用于轻松访问 Carerix REST API

2.3.0 2023-11-02 10:54 UTC

This package is auto-updated.

Last update: 2024-09-07 11:24:01 UTC


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); 

资源

要访问这些资源,您必须申请合作伙伴开发者帐户。

许可证

本项目的所有内容均受 MIT 许可证的许可。有关详细信息,请参阅 LICENSE 文件。

致谢

本项目高度受 Doctrine (www.doctrine-project.org) 实现 ActiveRecord 模式和 Doctrine REST API 客户端的启发。