shell/data-and-reporting-sdk

数据与报告产品包括API,提供关于壳牌卡的交易和发票信息的详细信息。壳牌卡交易和发票API基于REST,版本1使用基本认证,版本2端点使用OAuth认证。API端点接受JSON编码的请求体,返回JSON编码的响应,并使用标准HTTP响应代码。所有资源都位于壳牌卡平台。壳牌卡平台是包含所有用于管理资源的内部壳牌系统的整体平台。所有端点都使用POST动词来检索、更新、创建和删除壳牌卡平台中的资源。检索壳牌卡平台资源的端点允许在API请求体中使用灵活的搜索参数。

1.1.0 2024-09-20 06:54 UTC

This package is auto-updated.

Last update: 2024-09-20 06:54:56 UTC


README

介绍

数据与报告产品包括API,提供关于壳牌卡的交易和发票信息的详细信息。壳牌卡交易和发票API基于REST,版本1使用基本认证,版本2端点使用OAuth认证。API端点接受JSON编码的请求体,返回JSON编码的响应,并使用标准HTTP响应代码。所有资源都位于壳牌卡平台。壳牌卡平台是包含所有用于管理资源的内部壳牌系统的整体平台。所有端点都使用POST动词来检索、更新、创建和删除壳牌卡平台中的资源。检索壳牌卡平台资源的端点允许在API请求体中使用灵活的搜索参数。

前往壳牌开发者门户:https://developer.shell.com

安装包

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

composer require "shell/data-and-reporting-sdk:1.1.0"

或者手动将其添加到composer.json文件中,如下所示

"require": {
    "shell/data-and-reporting-sdk": "1.1.0"
}

您还可以在此查看包:https://packagist.org.cn/packages/shell/data-and-reporting-sdk#1.1.0

测试SDK

此SDK中的单元测试可以使用PHPUnit运行。

  1. 首先使用composer安装依赖项,包括require-dev依赖项。
  2. 从命令行运行vendor\bin\phpunit --verbose以执行测试。如果您已全局安装PHPUnit,请使用phpunit --verbose运行测试。

您可以在phpunit.xml文件中更改PHPUnit测试配置。

初始化API客户端

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

以下参数可配置为API客户端

API客户端可以如下初始化

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

环境

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

字段

授权

此API使用以下认证方案。

API列表

类文档