antistatique/trustedshops-php-sdk

Super-simple, minimum abstraction TrustedShops API v2.x wrapper, in PHP

1.0.0 2019-10-08 06:50 UTC

Requires

• php: >=7.0
• ext-curl: *
• ext-json: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12
• php-coveralls/php-coveralls: ^2.1
• php-mock/php-mock-phpunit: ^2.4
• phpmd/phpmd: ^2.6
• phpunit/php-code-coverage: ^6.0
• phpunit/phpunit: 7.0.*
• sebastian/phpcpd: ^4.0
• sensiolabs/security-checker: ^5.0
• symfony/dotenv: ^4.3

MIT

• Antistatique SA
• Kevin Wenger

README

Super-simple, minimum abstraction TrustedShops API v2.x wrapper, in PHP.

I hate complex wrappers. This lets you get from the TrustedShops API docs to the code as directly as possible.

Requires PHP 7.0+. Abstraction is for chimps.

Getting started

You can install trustedshops-php-sdk using Composer:

composer require antistatique/trustedshops-php-sdk

Examples

See the examples/ directory for examples of the key client features. You can view them in your browser by running the php built-in web server.

php -S localhost:8000 -t examples/

And then browsing to the host and port you specified (in the above example, http://localhost:8000).

Basic Example

Start by use-ing the class and creating an instance with your API key

use \Antistatique\TrustedShops\TrustedShops;

List all the shops (with a public call via get on the shops/{tsid} method)

$tsid = 'abc123abc123abc123abc123abc123';
$ts = new TrustedShops();
$response = $ts->get("shops/$tsid");
print_r($result);

Get all reviews (with a public call via get to the lists/{listID}/reviews method)

$tsid = 'abc123abc123abc123abc123abc123';
$ts = new TrustedShops();
$response = $ts->get("shops/$tsid/reviews");
print_r($result);

Read measurement matrix of review complaint indicator for a shop (with a restricted authenticated call via get on the shops/{tsid}/quality/complaints method)

Update a list member with more information (using patch to update):

$tsid = 'abc123abc123abc123abc123abc123';
$ts = new TrustedShops('restricted');
$ts->setApiCredentials( 'SECRET_USER', 'SECRET_PASSWORD');
$response = $ts->get("shops/$tsid/quality/complaints");
print_r($result);

Troubleshooting

To get the last error returned by either the HTTP client or by the API, use getLastError():

echo $ts->getLastError();

For further debugging, you can inspect the headers and body of the response:

print_r($ts->getLastResponse());

If you suspect you're sending data in the wrong format, you can look at what was sent to TrustedShops by the wrapper:

print_r($ts->getLastRequest());

If your server's CA root certificates are not up to date you may find that SSL verification fails and you don't get a response. The correction solution for this is not to disable SSL verification. The solution is to update your certificates. If you can't do that, there's an option at the top of the class file. Please don't just switch it off without at least attempting to update your certs -- that's lazy and dangerous. You're not a lazy, dangerous developer are you?