ADBD.com

Applications, Développement et Bande Dessinée

Accueil > API BD Tech > Utilisation de l’API BD Tech

Utilisation de l’API BD Tech

samedi 6 mars 2021, par Thomas Clément

Racine

Le point d’entrée à l’adresse

GET https://www.adbd.com/api-v1

Resources

Il y a trois ressources possibles pour le moment :
ouvrage : informations concernant un ouvrage donné
serie : liste des ouvrages appartenant à une série donnée
quota : fournit les nombre de requêtes que vous êtes autorisé à formuler

Authentification

Pour accéder à l’un de ces ressources, vous devez au minimum fournir un id_user (numérique, identifiant utilisateur) et une apikey (chaîne de caractères) dans votre URL :

GET https://www.adbd.com/api-v1/ressource?id_user=xxx&apikey=yyy

ressource est l’une des trois valeurs ouvrage, serie et quota.

Pendant toute la phase de test, ces éléments vous seront fournis sur demande via le formulaire de contact (lien en bas de chaque page)

Structure de la réponse

Les réponses aux requêtes sont fournies au format JSON (application/json). Elles ont toutes le même format :

{
        "statut" : un code numérique à 3 chiffres
        "message" : un message explicitant le code statut
        "quota" : nombre de requêtes restantes
        "donnees": réponse à la requête
}

Codes de statut

Succès
100 : requête effectuée, réponse trouvée
101 : effectuée, mais aucune réponse trouvée

Erreurs
200 : utilisateur non reconnu, la réponse n’est pas fournie
201 : quota épuisé, la réponse n’est pas fournie
210 : id_user manquant
211 : apikey manquante
220 : ressource manquante
221 : ressource non reconnue
230 : isbn manquant
231 : ouvrage non trouvé (il n’est pas dans la base de données)
240 : id_serie manquant
241 : série non trouvée

Un message, un commentaire ?

modération a priori

Ce forum est modéré a priori : votre contribution n’apparaîtra qu’après avoir été validée par un administrateur du site.

Qui êtes-vous ?
Votre message

Pour créer des paragraphes, laissez simplement des lignes vides.