Giter VIP home page Giter VIP logo

trustedshops-php-sdk's Introduction

TrustedShops PHP SDK

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.

Build Status StyleCI Coverage Status Packagist License

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?

trustedshops-php-sdk's People

Contributors

stevenavelino24 avatar wengerk avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.