shell/card-management-sdk

Shell卡管理API基于REST架构,并使用OAUTH 2.0、Basic和ApiKey认证。API端点接受JSON编码的请求体,返回JSON编码的响应,并使用标准的HTTP响应码。所有资源都位于Shell卡平台中。Shell卡平台是包含所有用于管理资源的内部Shell系统的整体平台。在与API交互时,平台的具体工作原理并不重要。但是,值得注意的是,平台使用微服务架构与各种后端系统通信,并且某些API调用是异步处理的。所有端点都使用POST动词来检索、更新、创建和删除Shell卡平台中的资源。从Shell卡平台检索资源的端点允许在API请求体中灵活指定搜索参数。

1.2.0 2024-09-20 07:12 UTC

This package is auto-updated.

Last update: 2024-09-20 07:13:16 UTC


README

介绍

Shell卡管理API基于REST架构,并使用OAUTH 2.0、Basic和ApiKey认证。API端点接受JSON编码的请求体,返回JSON编码的响应,并使用标准的HTTP响应码。
所有资源都位于Shell卡平台中。Shell卡平台是包含所有用于管理资源的内部Shell系统的整体平台。在与API交互时,平台的具体工作原理并不重要。但是,值得注意的是,平台使用微服务架构与各种后端系统通信,并且某些API调用是异步处理的。所有端点都使用POST动词来检索、更新、创建和删除Shell卡平台中的资源。从Shell卡平台检索资源的端点允许在API请求体中灵活指定搜索参数。

访问Shell开发者门户:https://developer.shell.com

安装包

运行以下命令来安装包并将依赖自动添加到您的composer.json文件中

composer require "shell/card-management-sdk:1.2.0"

或者按照以下方式手动将其添加到composer.json文件中

"require": {
    "shell/card-management-sdk": "1.2.0"
}

您还可以在此查看包:https://packagist.org.cn/packages/shell/card-management-sdk#1.2.0

初始化API客户端

注意:客户端的文档可以在此找到。这里。

以下参数可配置API客户端

API客户端可以按如下方式初始化

$client = ShellCardManagementAPIsClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->bearerTokenCredentials(
        BearerTokenCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->environment(Environment::SIT)
    ->build();

环境

SDK可以配置为使用不同的环境进行API调用。可用的环境有

字段

授权

此API使用以下认证方案。

API列表

类文档