Authentication phase

Each call requires an authentication based on the HTTP Basic Authentication method.

This method uses the Authorization HTTP header consisting of the word Basic followed by a string encoded in base64 containing a username and a password separated by a colon (:).

  • The username is the Shop ID: e.g. 69876357
  • Le mot de passe est défini dans le Back Office Expert : par exemple testpassword_DEMOPRIVATEKEY23G4475zXZQ2UA5x7M.

Le nom d’utilisateur et le mot de passe sont disponibles dans le Back Office Expert, menu Paramétrage > Boutique, onglet Clés d’API REST.

PARAMETER DESCRIPTION
User Username allowing to build the header Authorization string
Test password Password allowing to build the Authorization header string for test transactions (with test cards).
Production password Password allowing to build the Authorization header string for production transactions (with real cards).

How to build the “Authorization” HTTP header

  1. Create a string of the formusername:password
    69876357:testpassword_DEMOPRIVATEKEY23G4475zXZQ2UA5x7M
    
  2. Encode the obtained chain in base64
    Njk4NzYzNTc6dGVzdHBhc3N3b3JkX0RFTU9QUklWQVRFS0VZMjNHNDQ3NXpYWlEyVUE1eDdN
    
  3. Add the “Authorization” header to your request containing the word “Basic” followed by the string encoded in base64:
    Authorization: Basic Njk4NzYzNTc6dGVzdHBhc3N3b3JkX0RFTU9QUklWQVRFS0VZMjNHNDQ3NXpYWlEyVUE1eDdN
    

In PHP, the Authorization header will be calculated as follows:

$header = "Authorization: Basic " . base64_encode($username . ':' . $password);

The full HTTP request will look like this:

{
    "value": "my testing value"
}

Useful links

For more information on the implementation in different languages, see the following GitHub gists.