README

brandon14/amazon-sdk-php

NOTE: This library has not been fully tested, and should not be considered stable or suitable for production environments.

Table Of Contents

1. Requirements
2. Purpose
3. Installation
4. Standards
5. Coverage
6. Documentation
7. Contributing
8. Versioning
9. Security Vulnerabilities

Requirements

Purpose

A single package containing a PHP SDK to access all of Amazon OpenAPI spec SP-API endpoints found here. It only covers the RESTful APIs that have OpenAPI specifications available as found in the Amazon SP-API models repo here.

To view the OpenAPI files these packages were generated from, please browse the selling-partner-api-models/models directories.

NOTE: I do believe the EasyShip/V20220323 SDK might not be fully functional. Amazon has a model named String which is a reserved keyword in PHP >= 7, so any calls that may interact with that model may not function correctly. I am trying to work on a good fix for it.

Installation

You can install the entire bundle of Amazon libraries via:

composer require brandon14/amazon-sdk-php

If you wish to install individual API libraries, you can via the following (this would for example install the AplusContent/V20201101 library):

composer require brandon14/amazon-aplus-content-v20201101

# More generic:
# composer require brandon14/amazon-<api-namei-<version>

Standards

We strive to meet the PSR-12 coding style for PHP projects, and enforce our coding standard via the php-cs-fixer linting tool. Our ruleset can be found in the .php-cs-fixer.dist.php file.

Coverage

The latest code coverage information can be found via Codecov. We strive to maintain 100% coverage across the entire Amazon SP-API, so if you are contributing, please make sure to include tests for new code added.

Documentation

Documentation to this project can be found here.

Contributing

Got something you want to add? Found a bug or otherwise bad code? Feel free to submit pull requests to add in new features, fix bugs, or clean things up. Just be sure to follow the Code of Conduct and Contributing Guide, and we encourage creating clean and well described pull requests if possible.

If you notice an issues with the library or want to suggest new features, feel free to create issues appropriately using the issue tracker.

Versioning

php-licenses-generator uses semantic versioning that looks like MAJOR.MINOR.PATCH.

Major version changes will include backwards-incompatible changes and may require refactoring of projects using it. Minor version changes will include backwards-compatible new features and changes and will not break existing usages. Patch version changes will include backwards-compatible bug and security fixes, and should be updated as soon as possible.

Security Vulnerabilities

If you discover a vulnerability within this package, please email Brandon Clothier via brclothier@trollandtoad.com. All security vulnerabilities will be promptly addressed.

This code is released under the MIT license.

Copyright © 2022 Brandon Clothier

Contributors

😂 Here is a random joke that'll make you laugh!