emsearch/emsearch-php-client

emsearch Api PHP 客户端

维护者

详细信息

github.com/emsearch/emsearch-php-client

主页

源代码

问题

安装量: 24,698

依赖者: 0

建议者: 0

安全性: 0

星级: 0

关注者: 1

分支: 0

公开问题: 0

dev-master 2018-03-02 09:31 UTC

Requires

Requires (Dev)

MIT 64a3bb37ee78c9ea1723858c3112179a0c6dd3a8

  • Ryan Gilles <ryan.woop@e-monsite.com>

phpsdkems-searchemsearch

This package is not auto-updated.

Last update: 2024-09-20 01:41:55 UTC

README

需求

所需的唯一库是 Guzzle, PHP HTTP 客户端.

安装

composer require emsearch/emsearch-php-client

OpenAPI 规范文件

此 PHP 客户端库是使用位于根目录中的 openapi.json 文件生成的。将此文件内容复制到 editor.swagger.io 以查看所有可能性。

使用

初始化客户端

emsearch API 使用 OAuth2 访问认证。

第一个参数必须是一个有效的访问令牌。第二个参数是 API 入口 URL。第三个参数是可选的，是一个数组，将应用于内部 Guzzle 客户端的每个请求，允许指定错误接受的语言等。

/** @var \Emsearch\Api\ApiClient $apiClient */
$apiClient = new \Emsearch\Api\ApiClient(
    $token,
    'https://emsearch-api-entry-point.tld',
    ['Accept-Language' => 'en']
);

使用管理器请求资源

像这样使用主 API 客户端对象处理资源请求

/** @var \Emsearch\Api\Resources\UserResponse $userResponse */
$userResponse = $apiClient->MeManager()->getUser();

/** @var \Emsearch\Api\Resources\User $me */
$me = $userResponse->data;

待办事项

第一版发布后将提供更多文档...

即将推出的功能

  • 链接到主文档
  • 生成的单元测试