Skip to main content
Sauter la table des matières

Premiers pas avec l'API edoobox

Veuillez noter que l'assistance gratuite est limitée à ce domaine. Si vous souhaitez une assistance plus étendue, nous vous proposons volontiers des services payants.

Authentification avec la clé API

Générer une clé API

L'API V2 utilise les clés API de V2. Pour cela, celles-ci doivent d'abord être générées dans votre compte V2 :

  1. Vers Préférences > Gestion de l'accès à l'API naviguer sur le site.

  2. Cliquer sur Ajouter une clé pour générer une nouvelle clé.

  3. Sélectionnez le droit souhaité et cliquez ensuite sur Ajouter.

  4. Vous recevez maintenant deux clés API uniques que vous pouvez utiliser pour vous authentifier avec l'API V2. Conservez ces clés en lieu sûr, car elles ne sont délivrées qu'une seule fois dans leur intégralité.

Authentification et obtention de jetons d'accès

Les endpoints d'authentification ne sont pas protégés. Tous les terminaux API V2 protégés ne peuvent être utilisés qu'avec un access_token et d'une edid peuvent être utilisés. Le site edid définit quel compte a été actuellement authentifié. Afin de pouvoir access_token et les edid vous devez utiliser les clés API et vous authentifier en premier lieu. Le point d'accès pour s'authentifier est le suivant : https://app2.edoobox.com/v2/auth.

Vous trouverez ci-dessous quelques exemples d'authentification dans différents langages de programmation. Le site key est votre clé publique, qui secret est votre clé secrète et expire vous pouvez utiliser pour indiquer la date d'expiration du access_tokens à déterminer.

Dans la réponse, vous trouverez les edid et votre carte d'identité valide access_token. Vous trouverez également les droits des comptes actuellement connectés et leur ID de compte. Vous pouvez y accéder comme suit :

CODE 
data.login.data[edid]

Exemple de réponse API après authentification

CODE 
{
    "data": {
        // Die edid ID vom aktuellen Konto
        "edid": "63ef220a0c8f25O0O4833076730b351d639ea00000000000000000000",
        "login": {
            ...
            "data": {
                // alle aktiv eingeloggten Konten
                "63ef220a0c8f25O0O4833076730b351d639ea00000000000000000000": {
                    "id": "api_00000000_00000000",
                    "account": "account_00000000_00000000", // Konto ID
                    "auth": {
                        "rw": { // alle Rechte von diesen Schlüsseln
                            "admi": 3,
                            ...
                        }
                    }
                }
                "63ef220a0c8f25O0O4833076730b351d639ea0d4520f005f7f7347283": {
                    "id": "api_00000000_00000000",
                    "account": "account_00000000_00000001", // Konto ID
                    "auth": {
                        "sub": 1,
                        "rw": { // alle Rechte von diesen Schlüsseln
                            "admi": 3,
                            ...
                        }
                    }
                }
            }
        }
    },
    // Ihr gültiger Access Token
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
    ...
}

Requêtes avec code

Authentification

Authentification avec Node (JavaScript)

Pour ces exemples, nous utilisons la version node v18.13.0. Créer un fichier JavaScript auth.js avec le contenu suivant :

JS 
var myHeaders = new Headers();
myHeaders.append("grant-type", "password");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "key": "key_0000000000000000000000000000000",
  "secret": "sec_0000000000000000000000000000000",
  "expire": "2030-01-01T01:00:00+02:00"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://app2.edoobox.com/v2/auth", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Dans votre shell, allez dans le répertoire de ce fichier et exécutez le script :

BASH 
node auth.js

Authentification avec PHP

Créer un fichier PHP auth.php avec le contenu suivant :

PHP 
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://app2.edoobox.com/v2/auth',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
	"key": "key_0000000000000000000000000000000",
	"secret":"sec_0000000000000000000000000000000",
	"expire":"2030-01-01T01:00:00+02:00"
}',
    CURLOPT_HTTPHEADER => array(
        'grant-type: password',
        'Content-Type: application/json',
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Dans votre shell, allez dans le répertoire de ce fichier et exécutez le script :

BASH 
php auth.php

Consultation de toutes les offres

Une fois l'authentification effectuée, un cookie est écrit pour votre session. Vous possédez maintenant aussi la edid et le access_token et peuvent donc faire des requêtes à l'API. Dans cet exemple, nous allons consulter toutes les offres de ce compte (si vous avez sélectionné les bons droits lors de la création de la clé API). Le point d'accès utilisé pour cela est https://app2.edoobox.com/v2/offer/list. Faites attention aux en-têtes edid, grant-type et Autorisation. Ils sont essentiels au bon fonctionnement des requêtes. Cela concerne également tous les autres points d'accès protégés.

Requête avec Node (JavaScript)

Pour ces exemples, nous utilisons la version node v18.13.0. Créer un fichier JavaScript offers.js avec le contenu suivant. Remplacer eyJ0eXAiOiJKV sur le site Autorisation-avec votre propre jeton d'accès :

JS 
var myHeaders = new Headers();
myHeaders.append("edid", "63ef220a0c8f25O0O4833076730b351d639ea00000000000000000000");
myHeaders.append("grant-type", "access_token");
myHeaders.append("Authorization", "Bearer eyJ0eXAiOiJKV...");

var requestOptions = {
    method: 'GET',
    headers: myHeaders,
    redirect: 'follow'
};

fetch("https://app2.edoobox.com/v2/offer/list", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Dans votre shell, allez dans le répertoire de ce fichier et exécutez le script :

BASH 
node offers.js

Requête avec PHP

Créer un fichier PHP offers.php avec le contenu suivant. Remplacer eyJ0eXAiOiJKV sur le site Autorisation-avec votre propre jeton d'accès :

PHP 
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://app2.edoobox.com/v2/offer/list',
    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(
        'edid: 63ef220a0c8f25O0O4833076730b351d639ea00000000000000000000',
        'grant-type: access_token',
        'Authorization: Bearer eyJ0eXAiOiJKV...',
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Dans votre shell, allez dans le répertoire de ce fichier et exécutez le script :

BASH 
php offres.php

Requêtes avec Postman

Postman vous permet de tester facilement toutes les interfaces afin d'avoir une meilleure compréhension de l'API.

  1. Pour cela, vous devez d'abord installer Postman via le guide d'installation disponible sur le lien suivant : https://www.postman.com/downloads/.

  2. Ensuite, connectez-vous avec votre compte Postman.

  3. Visitez notre documentation API : https://api.docs.edoobox.com/.

  4. Dans notre documentation, cliquez en haut à droite sur Run in Postman.

  5. Il vous sera ensuite demandé si vous souhaitez ouvrir notre API via l'application de bureau ou via le navigateur. Cliquez sur l'option qui vous convient, dans cet exemple nous utilisons l'application de bureau.

  6. Vous serez peut-être invité à autoriser l'ouverture dans votre application de bureau. Cliquez sur autoriser. Si cette question n'est pas posée et que vous atterrissez directement dans votre application de bureau, passez au point suivant.

  7. Importez notre collection dans l'espace de travail de votre choix.

  8. Dans Postman, naviguez vers Environments et importez le fichier d'environnement ci-joint (example.postman_environment.json).

  9. Adaptez vos données dans votre environnement nouvellement importé (api_keyou user_email etc.).

  10. Allez dans notre collection sous Collections et sélectionnez en haut à droite l'environnement que vous venez d'ajouter.

  11. Vous pouvez maintenant vous inscrire via Auth (Login) > POST (Login) s'authentifient. Le site access_token et toutes les autres informations seront automatiquement ajoutées à votre fichier d'environnement après l'authentification. La requête API POST Auth est pour si vous utilisez la clé API pour l'authentification. La requête POST Auth Admin (connexion) est pour si vous utilisez l'e-mail et le mot de passe pour l'authentification.

  12. Après avoir sélectionné l'un des deux POST vous pouvez exécuter toutes les autres requêtes dans Postman.

example.postman_environment.json

Tutoriels associés

Mots-clés pour ce guide

API ¦ API V2 ¦ Postman ¦ Authentification

Erreurs JavaScript détectées

Veuillez noter que ces erreurs peuvent dépendre de la configuration de votre navigateur.

Si ce problème persiste, veuillez contacter notre service d'assistance.

Contact Support Close