Notities


  • Wij adviseren om Postman te gebruiken om test calls te doen (https://www.postman.com/).
  • Deel uw token met niemand. 
  • Mocht de huidige token gecompromitteerd zijn, verwijder deze dan en maak een nieuwe aan. 
  • U bent zelf verantwoordelijk wie u toegankelijk stelt tot uw data, ga hier voorzichtig mee om. 
  • Gebruik de token niet over HTTP calls. 
  • Je kunt gerust meerdere tokens tegelijkertijd gebruiken voor verschillende partijen/einddoelen. 

Voorgaande Criteriums


  1. Om gebruik te maken van de API heeft u een geldige webshop nodig.
  2. Enige data voor uw specifieke doeleind
  3. U moet een token hebben aangemaakt in het beheer systeem.

Token aanmaken


1. In Bernini onder 'Configuratie' -> 'Api' kunt u de Token aanmaken.


Geef de beschrijving op en klik op het knopje aan de rechterkant:

    

(plaatje: Bernini API Token Aanmaken)



2. Vervolgens zult u linksboven op dezelfde pagina een soort gelijke token zien, als volgt: 

(plaatje: Bernini API Token)


3. Gebruik deze token in uw calls om zo succesvol geauthenticeerd te worden.


Voorbeeld API Call


1. Gaat u naar https://apidocs.shoptrader.com/. 


2. Kies op deze website de call uit die u wilt doen, als voorbeeld zullen wij deze call nemen: https://apidocs.shoptrader.com/#/Customers/customersAction

(plaatje: Apidocs GET Customers Call)


3. Voer in de gevraagde veld(en) de benodigde gegevens in.

(plaatje: Apidocs GET Customers Parameter ID)


4. Klik op "Execute"

(plaatje: Apidocs GET Customers Call Execute)


5. U krijgt de volgende responses te zien in ons voorbeeld:

Curl: curl -X GET "https://swagger.shoptrader.com/api/v2/customers/1" -H  "accept: application/json"

Url: https://swagger.shoptrader.com/api/v2/customers/1

(plaatje: Apidocs GET Customers Call Responses)


6. Kopieer de curl of url naar uw code toe (of postman) en verander de volgende stukken: 

   6.1 swagger.shoptrader.com => {uw domein}

   6.2 achterin als laatst voegt u toe na de /1 => "?token={uw token die we eerder hebben aangemaakt}"

De links zien er dan als volgt uit: 

Curl: curl -X GET "https://{uw domein}/api/v2/customers/1?token={uw token}" -H  "accept: application/json"

Url: https://{uw domein}/api/v2/customers/1?token={uw token}


*U mag de token ook als header meegeven als u hiermee bekend bent.*


7. Als u de API Call uitvoert zult u een soorgelijke response zien:

(plaatje: Webshop API GET Customers Call Responses)


Mocht u het niet correct hebben gedaan dan zult u een error ontvangen zoals: 


Voorbeeld PHP Code

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{uw domein}/api/v2/customers/1?token={uw token}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;