cbdesk/key-management_api

dev-master 2023-01-12 10:41 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

Due to regulatory requirements applicable to our EU/UK sellers, for certain APIs, developers need to add digital signatures to the respective HTTP call. The Key Management API creates keypairs that are required when creating digital signatures for the following APIs:

• All methods in the <a href="/api-docs/sell/finances/resources/methods " target="_blank ">Finances API
• <a href="/api-docs/sell/fulfillment/resources/order/methods/issueRefund " target="_blank ">issueRefund in the Fulfillment API
• <a href="/Devzone/XML/docs/Reference/eBay/GetAccount.html " target="_blank ">GetAccount in the Trading API
• The following methods in the Post-Order API:
  • <a href="/Devzone/post-order/post-order_v2_inquiry-inquiryid_issue_refund__post.html " target="_blank ">Issue Inquiry Refund
  • <a href="/Devzone/post-order/post-order_v2_casemanagement-caseid_issue_refund__post.html " target="_blank ">Issue case refund
  • <a href="/Devzone/post-order/post-order_v2_return-returnid_issue_refund__post.html " target="_blank ">Issue return refund
  • <a href="/Devzone/post-order/post-order_v2_return-returnid_decide__post.html " target="_blank ">Process Return Request
  • <a href="/devzone/post-order/post-order_v2_cancellation-cancelid_approve__post.html " target="_blank ">Approve Cancellation Request
  • <a href="/devzone/post-order/post-order_v2_cancellation__post.html " target="_blank ">Create Cancellation Request

<span class="tablenote">Note: For additional information about keypairs and creating Message Signatures, refer to <a href= "/develop/guides/digital-signatures-for-apis " target= "_blank ">Digital Signatures for APIs.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: v1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/cbdesk/key-management_api.git"
    }
  ],
  "require": {
    "cbdesk/key-management_api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: api_auth
$config = Cbdesk\EbayKeyManagment\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Cbdesk\EbayKeyManagment\Api\Api\SigningKeyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Cbdesk\EbayKeyManagment\Api\Model\CreateSigningKeyRequest(); // \Cbdesk\EbayKeyManagment\Api\Model\CreateSigningKeyRequest | 

try {
    $result = $apiInstance->createSigningKey($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SigningKeyApi->createSigningKey: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: api_auth
$config = Cbdesk\EbayKeyManagment\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Cbdesk\EbayKeyManagment\Api\Api\SigningKeyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signing_key_id = "signing_key_id_example"; // string | The system-generated eBay ID of the keypairs being requested.

try {
    $result = $apiInstance->getSigningKey($signing_key_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SigningKeyApi->getSigningKey: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: api_auth
$config = Cbdesk\EbayKeyManagment\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Cbdesk\EbayKeyManagment\Api\Api\SigningKeyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getSigningKeys();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SigningKeyApi->getSigningKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://apiz.ebay.com{basePath}

Class	Method	HTTP request	Description
SigningKeyApi	createSigningKey	POST /signing_key
SigningKeyApi	getSigningKey	GET /signing_key/{signing_key_id}
SigningKeyApi	getSigningKeys	GET /signing_key

Documentation For Models

• CreateSigningKeyRequest
• Error
• ErrorParameter
• QuerySigningKeysResponse
• SigningKey

Documentation For Authorization

api_auth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• https://api.ebay.com/oauth/api_scope: View public data from eBay

Author