L’API (APPLICATION PROGRAMMING INTERFACE) DE DEXERO FD FOURNIT L’ACCÈS AUX RESSOURCES (LES ENTITÉS DE DONNÉES) VIA LES CHEMINS URI.
POUR UTILISER L’API REST, VOTRE APPLICATION FERA UNE REQUÊTE HTTP, PUIS DÉCODERA LA RÉPONSE. PAR DÉFAUT, LE FORMAT DE RÉPONSE EST LE XML. SI VOUS LE SOUHAITEZ, VOUS POUVEZ DEMANDER JSON AU LIEU DE XML.
PUISQUE L’API REST EST BASÉE SUR DES STANDARDS OUVERTS, VOUS POUVEZ UTILISER N’IMPORTE QUEL LANGAGE DE DÉVELOPPEMENT WEB POUR Y ACCÉDER.
L’API DE DEXERO FD OFFRE
LES FONCTIONNALITÉS SUIVANTES :
- Récupération d’une liste de fiches;
- Création de fiches;
- Modification de fiches;
- Recherche.
L’API DE DEXERO FD EST SOUS CONTRÔLE DE VERSIONS.
LE NUMÉRO DE VERSION D’API APPARAÎT DANS SON URI.
PAR EXEMPLE, UTILISEZ CETTE STRUCTURE URI POUR
DEMANDER LA VERSION 2 DE L’API DEXERO FD :
Informations sur l’API :
- Dernière version : 6
- Sécurité : SSL
Ex. : https://fd.dexero.com/services/v6/rest/
NOTES:
- Le numéro de version de l’API est un nombre entier,
tel que 1 ou 2. - La version de l’API est indépendante de la version
Dexero FD communiquée. - La version de l’API peut changer avec une nouvelle
version de Dexero FD. - Le numéro de version de l’API ne changera que lorsque
les mises à jour de celle-ci rompent le contrat API,
nécessitant des modifications dans le code qui utilise l’API. - Un ajout à l’API ne requiert pas nécessairement un
changement du numéro de version de l’API.
AUTHENTIFICATION ET AUTORISATION
L’authentification donne à votre application la capacité de lire et d’écrire des données via les API. La plateforme Dexero FD utilise OAuth 2.0 pour l’authentification et l’autorisation. OAuth 2.0 exige HTTPS.
OAuth 2.0 est un protocole qui permet aux partenaires et aux applications d’interagir avec Dexero FD. L’objectif principal de fournir un soutien OAuth 2.0 est de permettre aux développeurs d’interagir avec Dexero FD sans stocker les informations d’identification sensibles. Notre mise en œuvre permet également aux utilisateurs de gérer leurs propres connexions.
Si vous connaissez peu le protocole OAuth, vous pouvez en apprendre plus sur le site Web.
Si vous êtes déjà familiarisé avec OAuth 2.0, vous n’avez qu’à connaître le point de terminaison du jeton.
Avant de commencer à développer une application utilisant Dexero FD, vous aurez besoin d’un numéro de client et d’une clé secrète du client. Le numéro de client et la clé secrète du client serviront à authentifier votre demande et à vérifier que les appels faits sont valables.
SÉCURITÉ
Selon le contexte d’utilisation, les informations d’identification peuvent offrir un accès à une grande quantité de données. Plus le nombre d’applications qui utilisent la même information d’autorisation est élevé, plus le risque qu’elle soit compromise est grand. Il est extrêmement important que les informations d’identification utilisées pour authentifier le client soient considérées comme étant hautement confidentielles. Idéalement, il serait préférable de les renouveler sur une base régulière.
ÉCHANGE D’INFORMATIONS D’IDENTIFICATION DE L’APPLICATION POUR UN JETON D’ACCÈS
L’application doit demander un jeton d’accès à partir du serveur d’autorisation pour l’authentification de la demande avec ses informations d’identification client.
PARAMÈTRES POST
client_id : La valeur fournie pour vous lorsque vous avez enregistré votre demande.
client_secret : La valeur fournie pour vous lorsque vous avez enregistré votre demande.
scope : read
grant_type : client_credentials
RÉCEPTION D’UN JETON D’ACCÈS PHP
$credentials = "your_client_id:your_client_secret";
$curl = curl_init( "https://fd.dexero.com/oauth/token.action" );
curl_setopt( $curl, CURLOPT_POST, true );
curl_setopt( $curl, CURLOPT_POSTFIELDS,
'scope=read&grant_type=client_credentials');
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $curl, CURLOPT_HTTPHEADER, array( 'Authorization: Basic ' . base64_encode($credentials) ) );
$auth = curl_exec( $curl );
$secret = json_decode($auth);
$access_key = $secret->access_token;