Download the PHP package onetech/sp-api-sdk without Composer

On this page you can find all versions of the php package onetech/sp-api-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of onetech/sp-api-sdk

Informations about the package sp-api-sdk

Amazon Selling Partner API - PHP SDK

[!CAUTION] This project is currently not actively maintained. I don't have any Amazon Developer Account that I could use for testing, plus I don't work with Amazon API's anymore. If anyone would be interested in taking over maintenance of this project, please reach out to [email protected]

This repository is not an official Amazon PHP library for their SP API.

social-preview

Why next library?

The main goal of this SDK is to provide SDK's for the Amazon SP API in a way that would let the application to pass Amazon audit.

Amazon audit might happen to systems that must access API endpoints with PII.

There are already few php sp api SDKs available for PHP however most of them comes with many issues of auto generated code.

This library goal is to resolve all above mentioned issues.

Installations

This library is not in a stable stage yet, please use with caution.

Releases

branch maintained
1.x 🚫
2.x 🚫
3.x ✅
4.x ✅
5.x ✅

Version 1.x is deprecated becuase of the attempt to make a little more sense of what Amazon is doing with using "tags" in their Open API specification. This attempt failed and in order to keep Backward Compatibility promise, changes in the class names had to be introduced in 2.x. Version 1.0 is not going to be updated anymore, please migrate to version 2.0 that will stay consistent with Amazon Models Branch 3.x comes with BC breaks introduced by Amazon in Catalog Item models. Until old model won't go away, branches 2.x and 3.x should be maintained in parallel.

4.x comes with BC breaks in following Amazon api models:

5.x moves to Catalog Item API version 2022-04-01 which is replacing version 2020-12-01. Additionally, uuid used to generate correlation identifiers was replaced with IdGenerator interface that by default is using php internal uniqid(). This change allowed us to drop one additional dependency. Some minor adjustments were made in the template files for models/api.

Available SDKs

SellingPartnerSDK - Facade for all SDK's

Authorization

In order to start using SP API you need to first register as a Developer and create application. Whole process is described in Amazon Official Guides.

Amazon recommends to use Role IAM when creating application however this requires and additional API request in order to obtain access token. It's easier to use User IAM and just make sure that the user has following Inline Policy

IAM User

Example of changing refresh token into access token.

IAM Role

Development

99% of code in this library is auto generated from Amazon Selling Partner API Models using OpenAPI Generator tool. Output is later automatically upgraded by RectorPHP to PHP 7.4 version and finally coding standards are also automatically unified by PHP CS Fixer.

Requirements:

In oder to regenerate code (for example when API definitions change), execute following code:

Examples

Logging

Default log level is set up to DEBUG, but it can be changed in configuration to any other level for all operations in all APIs or only for given operation in given API.

Specific API's or only given operations can be also excluded from logging (for example APIs with PII or sensitive data).

Finally, you can also ignore specific headers when logging http request/response. By default, configuration is set to ignore following sensitive authorization headers:

you can also add your own ignored headers:

Extensions

Each SDK allows you to register custom extensions executed before and after sending API requests.

Sandbox

Sandbox mode can be turned on using configuration:

Some APIs endpoints are covered in functional tests. To run tests that are using sandbox mode, you need to create .env file and populate it with your credentials:

Then you can enter composer test:functional te execute sandbox test suite.

All versions of sp-api-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ~8.1 || ~8.2
ext-curl Version *
ext-json Version *
ext-mbstring Version *
psr/http-client Version ^1.0.1
psr/http-factory Version ^1.0
psr/log Version ^1.1||^2.0||^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package onetech/sp-api-sdk contains the following files

Loading the files please wait ....