README

此SDK旨在帮助您处理Cadulis API

安装

建议使用Composer安装InterventionSDK。

composer require cadulis/sdk "~1.0"

这将安装SDK及其所有依赖项。

因此，您的每个PHP脚本都需要要求引入Composer自动加载文件

<?php

require 'vendor/autoload.php';

使用

可用的服务包括

• Intervention（搜索、创建、更新、读取）
• InterventionType（getAvailable）
• ScheduleWizard（getSlots）

API初始化

使用您的访问URL初始化API

$autoconfigUrl = 'https://api.cadulis.com/connectors/XXX/YYYYYYYYY';

$cadulisAPI = \Cadulis\Sdk\InterventionApi::init($autoconfigUrl);

Intervention服务

您可以直接从api $cadulisAPI->services 访问服务

$cadulisSdkService = $cadulisAPI->services->newServiceIntervention();

搜索干预

检索SearchInput对象以设置所有需要的输入参数

$searchInput = $cadulisSdkService->newSearchInput();
$searchInput->status = \Cadulis\Sdk\Model\Intervention::STATUS_PENDING;

在interventionService上使用search方法获取您的干预

$result = $interventionService->search($searchInput);

返回结果是\Cadulis\Sdk\Model\Response\Interventions的实例

echo $results->pagination->returned . " results returned\n";
foreach ($results->interventions as $intervention) {
    echo "Intervention cref : " . $intervention->cref . "\n";
}

一站式搜索干预

// initialize api
$autoconfigUrl = 'https://api.cadulis.com/connectors/XXX/YYYYYYYYY';
$cadulisAPI = \Cadulis\Sdk\InterventionApi::init($autoconfigUrl);
// get service
$cadulisSdkService = $cadulisAPI->services->newServiceIntervention();
// get input
$searchInput = $cadulisSdkService->newSearchInput();
$searchInput->status = \Cadulis\Sdk\Model\Intervention::STATUS_PENDING;
// call method
$result = $cadulisSdkService->search($searchInput);
// process results
echo $results->pagination->returned . " results returned\n";
foreach ($results->interventions as $intervention) {
    echo "Intervention cref : " . $intervention->cref . "\n";
}

读取/创建/更新干预

实例化新的intervention模型

$intervention = $cadulisAPI->models->newModelIntervention();

cref字段是必需的（用于设置或检索唯一干预信息），这是您的干预唯一标识符

$intervention->cref = 'myCustomInterventionReference';

读取干预数据

$result = $interventionService->read($intervention);

通过cref查找干预

创建或更新干预

如果需要，您可以实例化新的customer模型。 customer类型/引用字段是唯一标识符

$intervention->customer = $cadulisAPI->models->newModelCustomer();
$intervention->customer->type = \Cadulis\Sdk\Model\Customer::CUSTOMER_TYPE_COMPANY;
$intervention->customer->reference = 'customerReference';

创建

$result = $interventionService->create($intervention);

如果已经存在具有cref的干预，则将其更新

更新

$result = $interventionService->update($intervention);

通过cref查找干预

干预和客户字段来自相应的类。它们是

$intervention->cref // unique identifier
$intervention->reference
$intervention->address
$intervention->address_additional
$intervention->comment
$intervention->duration // seconds
$intervention->scheduled_start_at // ISO 8601 format, can be set by $intervention->setScheduledStart($date)
$intervention->custom_fields // associative array of $key => $value additional fields

$customer->reference
$customer->type
$customer->name
$customer->address
$customer->address_additional
$customer->phone
$customer->mobile
$customer->email
$customer->comment

InterventionType服务

您可以检索您的可用intervention类型。如果您有多个，创建干预时将需要选择您想要哪一个。

$interventionTypeService = $cadulisAPI->services->newServiceInterventionType();
$result = $interventionTypeService->getAvailable();

调度向导服务

要获取可用分配时段，请使用ScheduleWizard !!!

检索ScheduleWizardInput对象以设置所有需要的输入参数

$scheduleWizardService = $cadulisAPI->services->newServiceScheduleWizard();
$scheduleWizardInput = $scheduleWizardService->newWizardInput();
$scheduleWizardInput->address = '7 rue de la Dordogne Toulouse';

在scheduleWizardService上使用getSlots方法获取可用时段

$result = $scheduleWizardService->getSlots($scheduleWizardInput);

返回结果是\Cadulis\Sdk\Model\Response\ScheduleWizard\ScheduleWizard的实例

echo count($result) . ' dates returned' . "\n";
echo 'best slot : ';
$bestSlot = $result->getBestSlot();
if ($bestSlot === null) {
    echo "No slot available";
} else {
    echo "Best slot : " . $bestSlot->date;
}

调度向导的获取选项

$scheduleWizardInput->address
$scheduleWizardInput->date_min // ISO 8601 format, can be set by $intervention->setDateMin($date)
$scheduleWizardInput->date_max // ISO 8601 format, can be set by $intervention->setDateMax($date)

日志

您可以在SDK中使用一个logger对象。它只需要实现\Bixev\LightLogger\LoggerInterface

class MyLogger implements \Bixev\LightLogger\LoggerInterface
{
    public function log($log)
    {
        print_r($log);
    }
}

然后将其传递给您的API初始化

$logger = new MyLogger;
$cadulisAPI = \Cadulis\Sdk\InterventionApi::init($autoconfigUrl, $logger);

覆盖路由

您可以使用强制路由使SDK连接到API（不使用autoconfig或覆盖）

路由在客户端级别

$client = $cadulisAPI->getClient();
$routes = $client->getRoutes();

因此，您可以简单地设置您自己的路由集。一个路由必须扩展\Cadulis\Sdk\Model\Routes\Route

$route = new \Cadulis\Sdk\Model\Routes\Route;
$route->identifier = \Cadulis\Sdk\Model\Routes\Route::IDENTIFIER_INTERVENTION_LIST;
$route->method = \Cadulis\Sdk\Client\Curl::METHOD_GET;
$route->url = 'http://mycutomdomain/mycutomroute';
$routes[] = $route;