README

Introduction
Requirements
Installation
Documentation Publishing
- Automatic Documentation Publishing
Usage
Local Development
Contributing

Introduction

A Software Development Kit for the Amazons Selling Parterns API (SPAPI) Tokens API.

Requirements

PHP 7.1 or higher.

Installation

Install Zerotoprod\SpapiTokensSdk via Composer:

composer require zero-to-prod/spapi-tokens-sdk

This will add the package to your project’s dependencies and create an autoloader entry for it.

Documentation Publishing

You can publish this README to your local documentation directory.

This can be useful for providing documentation for AI agents.

This can be done using the included script:

# Publish to default location (./docs/zero-to-prod/spapi-tokens-sdk)
vendor/bin/zero-to-prod-spapi-tokens-sdk

# Publish to custom directory
vendor/bin/zero-to-prod-spapi-tokens-sdk /path/to/your/docs

Automatic Documentation Publishing

You can automatically publish documentation by adding the following to your composer.json:

{
    "scripts": {
        "post-install-cmd": [
            "zero-to-prod-spapi-tokens-sdk"
        ],
        "post-update-cmd": [
            "zero-to-prod-spapi-tokens-sdk"
        ]
    }
}

Usage

Call the Tokens API to get a Restricted Data Token (RDT) for restricted resources.

use Zerotoprod\SpapiTokensSdk\SpapiTokensSdk;

$CreateRestrictedDataTokenResponse = SpapiTokensSdk::createRestrictedDataToken(
    'access_token',     // The access token to create the RDT
    'path',             // The path in the restricted resource.
    ['dataElements'],   // Indicates the type of Personally Identifiable Information requested.
    'targetApplication',// The application ID for the target application to which access is being delegated
    'base_uri',         // The user agent for the request.
    'user_agent'        // Optional. The URL for the api.
    ['options']         // Merge curl options
);

// Get Restricted Data Token
$token = $CreateRestrictedDataTokenResponse->response->restrictedDataToken

// Errors
$CreateRestrictedDataTokenResponse->response->errors[0]->message;

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

Fork the repository.
Create a new branch (git checkout -b feature-branch).
Commit changes (git commit -m 'Add some feature').
Push to the branch (git push origin feature-branch).
Create a new Pull Request.

zero-to-prod / spapi-tokens-sdk

Maintainers

Details