Configuration & Authentification
Temps de lecture estimé :
Configuration
La version actuelle de l'API est disponible à l'adresse https://api.tdoct.com/v1 . Il s'agit d'un service Web standard qui accepte les requêtes GET et POST. Toutes les réponses (y compris les messages d'erreur) utilisent le format JSON. Les requêtes POST acceptent également les entrées JSON (assurez-vous d'inclure l'en-tête Content-Type: application/json ).
Authentification
L'API utilise des en-têtes HTTP personnalisés pour authentifier vos demandes. Vous devrez ajouter des en App-Id - App-Key têtes à chaque demande que vous faites. Trouvez vos informations d'identification sur la page Applications (lorsque vous êtes connecté) .
Rappel
Pour mieux comprendre les API, indiquons ce qu'elles ne sont PAS : Une API n'est pas nécessairement un service externe. Par exemple, vous pouvez inclure des bibliothèques directement dans votre solution OU les utiliser via une API.
Une API n'est pas seulement une interface. C'est à la fois la spécification / format et la mise en œuvre.
Une API n'est pas une interface graphique. Il ne fait pas d'interactions au niveau graphique ; il fonctionne uniquement sur la couche programmatique, soit par l'intermédiaire d'un langage de programmation, soit par un protocole de communication.
Créez un nouveau dossier pour ce projet, utilisez npm init dans le dossier et démarrez votre éditeur de texte. Maintenant, créez un fichier index.js, puis ouvrez le fichier package.json. Dans celui-ci, ajoutez les lignes suivantes dans l'objet racine :
"bin": {"discounts": "./index.js"
}
Nous aurons aussi besoin du package commander pour analyser les entrées du client. Exécutez npm install --save commander dans le dossier actuel. Nous utiliserons également une petite librairie pour créer des identifiants. Vous pouvez l'installer avec npm install --save shortid. Pendant que nous y sommes, exécutons également npm install --save request pour nous faciliter les appels HTTP.
Concentrons-nous ici sur la fonction request. C'est ici que nous appelons l'API externe à TdocT. Vous pouvez voir que nous passons method : "POST" à la méthode. C'est parce que nous voulons publier des données sur l'API de TdocT. En spécifiant cette méthode, l'API mappera l'action correctement afin qu'elle puisse lire le corps de la requête où se trouvent les données de remise.
concepts d'authentification
Dans notre cas, nous transmettons la clé API directement dans la requête et le serveur nous reconnaît ! Il peut alors exécuter la requête limitée à notre compte.
Si vous voulez tester notre petite application, vous pouvez lancer npm install -g dans le répertoire du projet et simplement lancer discounts x pour créer des remises x nombre de fois. Vous pouvez aller dans votre tableau de bord TdocT et voir par vous-même que le checker a transmis les résultats des checklists.
Dernières mises à jour : 5 February 2021
Views: 20
Sur cette page :