Skip to content

Latest commit

 

History

History
78 lines (67 loc) · 2.01 KB

README.md

File metadata and controls

78 lines (67 loc) · 2.01 KB
Raw

Trustpilot

API Specification

Usage

Create a trustpilot client

The \PodPoint\Reviews\Reviews class requires, configuration array to be passed in the constructor.

Example config:

$config = [
    'trustpilot' => [
        'username' => env('TRUSTPILOT_USERNAME'),
        'password' => env('TRUSTPILOT_PASSWORD'),
        'client_secret' => env('TRUSTPILOT_SECRET_KEY'),
        'client_id' => env('TRUSTPILOT_CLIENT_ID'),
        'business_unit_id' => env('TRUSTPILOT_BUSINESS_ID'),
    ],
];

Any PHP Application

$reviews = new \PodPoint\Reviews\Reviews($config);
$trustpilot = $reviews->withProvider('trustpilot')

Laravel:

$trustpilot = \PodPoint\Reviews\Facade\Reviews::trustpilot();

Send a merchant invite

Required Fields:

  • consumerEmail
  • consumerName
  • referenceNumber
$trustpilot->merchant()->invite([
    'consumerEmail' => 'john.doe@trustpilot.com',
    'consumerName' => 'John Doe',
    'replyTo' => 'john.doe@trustpilot.com',
    'referenceNumber' => 'inv00001',
    'locale' => 'en-US',
    'senderEmail' => 'john.doe@trustpilot.com',
    'serviceReviewInvitation' => [
        'preferredSendTime' => '2013-09-07T13:37:00',
        'redirectUri' => "http://trustpilot.com',
        'tags'=>  [
          'tag1',
          'tag2'
        ],
        'templateId' => '507f191e810c19729de860ea'
      ],
     'locationId' =>  'ABC123',
     'senderName' =>  'John Doe'
]);

Get service reviews

$trustpilot->merchant()->getReviews([
    'startDateTime' => '2013-09-07T13:37:00',
    'endDateTime' => '2013-09-20T13:37:00',
]);

See all supported query parameters and responses: Api docs

Find service review

$trustpilot->merchant()->findReview($reviewId);

See response example: Api docs