ems-shield/ems-shield-php-client

ems-shield API PHP 客户端

维护者

详细信息

github.com/ems-shield/ems-shield-php-client

主页

源代码

问题

安装数: 24,616

依赖关系: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

dev-master 2018-06-08 12:42 UTC

Requires

Requires (Dev)

MIT cd59d73993160900414af3b41c24d0d83651d043

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

phpsdkems-shield

This package is not auto-updated.

Last update: 2024-09-20 01:33:00 UTC

README

要求

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

安装

composer require ems-shield/ems-shield-php-client

OpenAPI 规范文件

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

使用

初始化客户端

ems-shield API 使用 OAuth2 访问认证。

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

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

使用管理器请求资源

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

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

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

待办事项

更多文档将在首次发布时提供...

即将推出的功能

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