edoobox API

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.

Qu'est-ce que l'API d'edoobox ?

Avec l'API edoobox, les clients d'edoobox ont un accès direct à toutes les données. Cela facilite la connexion à des applications tierces et une sortie individuelle sur leur site web. Toutes les ressources d'edoobox sont incluses via un jeton web JSON et les options POST, PUT, GET et DELETE sont bien entendu disponibles pour toutes les ressources.

Groupes d'autorisation

Avec l'API V2, vous avez la possibilité de doter les API de droits adaptés. Par exemple, si vous avez besoin de toutes les informations de facturation pour votre outil de comptabilité, vous autorisez uniquement les informations nécessaires dans un groupe de droits créé spécialement pour l'API.

Les 4 groupes d'autorisation principaux "Droits de superadministrateur", "Droits d'administrateur et de responsable", "Droits de responsable limités" et le "Responsable (limité)" sont conçus pour limiter l'accès des administrateurs au système. Ils peuvent également être utilisés pour l'accès à l'API V2, car en tant qu'administrateur, on obtient automatiquement l'accès à l'API V2 avec ses données de connexion.

Veuillez noter que : Autres groupes d'autorisation

edoobox propose cependant, si l'on veut introduire des restrictions sur l'API V2, de créer un nouveau groupe d'autorisation pour éviter qu'un admin ne perde un droit pertinent pour l'administrateur. Cela pourrait en effet conduire à ce que l'APP ne fonctionne pas comme prévu ou à ce que trop de droits soient attribués à l'API.

Accès à l'API V2

Le lien suivant vous permet d'accéder au postman de l'API edoobox V2 : https://api.docs.edoobox.com/

Conseil : Postman (développeur)

Postman permet de créer, de tester, de simuler et de déboguer les requêtes API, ce qui facilite le développement des API pour tous.

Info : URL de base

Pour vous connecter, veuillez utiliser votre nom d'utilisateur et votre mot de passe d'administrateur edoobox ainsi que l'URL de base"https://app2.edoobox.com/v2".

Accès avec Postman

Si vous travaillez avec Postman, créez un environnement avec toutes les variables nécessaires. Après avoir créé l'environnement dans le Postman, sélectionnez cet environnement et exécutez le /auth-pour le faire. Vous trouverez une exécution plus détaillée de ces deux étapes dans le guide : Premiers pas avec l'API edoobox Variables d'environnement possibles pour l'accès aux API POST Auth Interface :

base_url	https://app2.edoobox.com/v2
api_key	key_330498self9450ss93464ls345
api_sec	sec_e1b3d4bdbf273450405ab342
edid
token
expire
yubikey

Actuellement, il n'est pas possible de publier des environnements dans la documentation.

Accès sans Postman

Avec curl une requête typique ressemblerait à ceci. Les requêtes dans d'autres langages de programmation peuvent être créées.

CODE

curl --location -g --request POST 'https://app2.edoobox.com/v2/auth' --header 'grant-type: password' --head
er 'Content-Type: application/json' --data-raw '{
"key": "<Ihr key-Schlüssel>",
"secret":"<Ihr sec-Schlüssel>",
"expire":"2030-01-01T01:00:00+02:00"
}'

Le code peut être exécuté dans un conteneur Docker indépendant et devrait renvoyer le statut HTTP 200 avec la réponse JSON souhaitée.

Info : Codes ERROR de l'API

Vous trouverez une liste complète de tous les codes d'erreur sur le lien suivant : edoobox API V2

Info : API non valide

Vérifier que les clés API sont valables pour l'environnement Sandbox ou Live et qu'elles sont activées.

Info : authentification par nom d'utilisateur et mot de passe

L'API V2 permet l'authentification par mot de passe et nom d'utilisateur uniquement avec le cookie HTTPOnly. Dans la requête, la propriété reply en tant que valeur cookie doit être définie. Ensuite, pour toutes les autres requêtes, les en-têtes cookie avec le cookie _edlogin=<cookie-token>, edid: <edid> et le grant-type : access_token sont inclus.

Si l'on souhaite un token au lieu d'un cookie HTTPOnly, on peut s'authentifier avec la clé d'authentification.

Accès à l'API V1

La "Gestion d'accès API V1" se trouve dans la "Navigation principale" sous "Paramètres".
Pour avoir accès à l'API V1, vous devez créer des clés API dans votre compte edoobox. Pour cela, allez dans les "Paramètres", que vous trouverez dans la "Navigation principale". Sous "Gestion des accès API", vous pouvez sélectionner le bouton "Ajouter une clé".

edoobox REST API V1 - Instructions

Info : API V1

L'API V1 n'est plus développée et ne devrait plus être utilisée pour cette raison. Les interfaces existantes continueront à fonctionner.
L'API V1 est également utilisée pour le plug-in WordPress. Dans ce cas, il n'est pas nécessaire de créer une nouvelle clé.

Tutoriels associés

Mots-clés pour ce guide

API ¦ Clés API ¦ Postman ¦ Codes ERROR