Glossaire API
Terminologie essentielle pour tout développeur d'API
API (interface de programmation d'applications)
Un ensemble de définitions et de protocoles permettant à des applications logicielles de communiquer entre elles. Les APIs définissent les méthodes et formats d'échange d'informations.
Exemple : Requiems API fournit une API REST pour valider des adresses e-mail par programme.
Point de terminaison (endpoint)
Une URL précise où une API accède aux ressources nécessaires. Chaque point de terminaison correspond à une fonction ou ressource donnée.
Exemple : POST /v1/networking/disposable/check
Authentification
Vérification de l'identité d'un utilisateur ou d'une application. Les APIs exigent en général une authentification pour limiter l'accès aux clients autorisés.
Exemple : inclure votre clé API dans l'en-tête Authorization : Authorization: Bearer VOTRE_CLE_API
Clé API
Identifiant unique servant à authentifier les requêtes. Elle sert à la fois d'identifiant et de secret.
Exemple : req_live_1234567890abcdef
Limitation de débit
Technique pour limiter le nombre de requêtes dans une fenêtre de temps. Limite les abus et garantit un usage équitable.
Exemple : la formule gratuite autorise 30 requêtes par minute
Requêtes
Unité d'usage de l'API. Chaque appel compte pour 1 requête sur votre quota mensuel. Certains points de terminaison peuvent compter plus ; c'est indiqué dans leur documentation.
Exemple : un appel au point de terminaison de validation e-mail consomme 1 requête sur votre quota.
REST (Representational State Transfer)
Style d'architecture pour applications réseau. Les APIs REST utilisent HTTP pour les opérations CRUD sur les ressources.
Exemple : GET pour lire, POST pour créer, PUT pour mettre à jour, DELETE pour supprimer
JSON (JavaScript Object Notation)
Format d'échange léger, lisible par les humains et facile à parser par les machines. La plupart des APIs modernes utilisent JSON pour les corps de requête/réponse.
Exemple : {"email": "[email protected]", "is_disposable": false}
Codes de statut HTTP
Codes à trois chiffres indiquant le résultat d'une requête HTTP. Exemples : 200 (succès), 404 (introuvable), 500 (erreur serveur).
En savoir plus : Référence des codes d'erreur
Webhook
Mécanisme pour qu'une application pousse des informations en temps réel vers une autre, au lieu de requêtes répétées depuis le client.
Exemple : recevoir une notification lorsque votre solde de requêtes passe sous un seuil
Paramètres de requête
Paires clé-valeur ajoutées à l'URL pour filtrer, trier ou modifier la réponse. Ils apparaissent après le « ? ».
Exemple : /v1/words?limit=10&min_length=5
En-têtes
Métadonnées envoyées avec les requêtes et réponses HTTP : jetons d'authentification, types de contenu, etc.
Exemple : Content-Type: application/json
Besoin d'aide ?
Consultez notre documentation complète ou contactez le support