README

这是什么？

一个实现Dellin API的PHP库，API地址为https://dev.dellin.ru。

安装

PHP 7.2+ 是最低要求，因为使用了新功能。

通过 Compose 安装软件包

$ composer require niklan/dellin-api

文档

官方 Dellin 文档

示例

该库只是 Dellin 目标端点的 PHP 包装器集合。

当前库仅支持 json 格式。没有 XML 解码器和编码器，我没有计划实现它。

公共 API 认证

dev.dellin.ru 所需的最小认证是 appkey，表示为 AppkeyAuth。

$auth = new AppkeyAuth('MY-DELLIN-APPKEY');

会话认证

此认证方法用于一些需要 sessionID 的 "客户端特定" API。

$auth = new SessionAuth('MY-DELLIN-APPKEY', 'SESSION-TOKEN-ID');

构建客户端

发送请求需要实例化 HttpClient 表示。它要求您传递两种认证方法之一。它们将在请求发送时使用。

$client = new HttpClient($auth);

发送请求

您可以使用 $client 中的 request() 方法向任何 Dellin API 发送请求。

在第一个参数中，您传递 API 端点 不包含 基础 URI 和格式，并在第二个参数中传递您的参数。

// @see https://dev.dellin.ru/api/auth/login/
$response = $client->request('/v1/customers/login', ['login' => 'example', 'password' => '123']);
$result = $response->getResult();

使用 PHP 包装器发送请求。

端点包装器简单，只是以更友好的方式收集要发送的数据。

上述请求使用包装器

$request = new Login('example' , '123');
$response = $client->execute($request);
$result = $response->getResult();

这种方式

您无需每次都处理端点。您只需使用语义对象。
API 所需的所有参数都由对象构造函数要求，因此您不会错过任何内容。
所有可选参数由设置器设置。

如果创建，最好在 2.x 版本中实现 php-http.org 与 PSR-18。

niklan / dellin-api

维护者

详细信息