Espace développeurs

Introduction

Esendex vise à rendre nos API accessibles et à simplifier l’envoi et la réception de messages. Sur cette page, nous vous proposons une brève introduction aux API. Pour en savoir plus, veuillez consulter l’Espace développeurs.

Regardez la vidéo ci-dessous pour un aperçu de l’Espace développeurs.

Video

Qu’est-ce qu’une API ?

Une API, ou interface de programmation d’applications, connecte votre application à d’autres services ou sources de données. Lorsque vous effectuez un appel API, vous demandez des données, l’API les récupère et vous envoie une réponse. Pour ce faire, il vous suffit d’utiliser une méthode HTTP pour effectuer votre requête.

Imaginez que vous commandiez au restaurant. Vous indiquez votre commande au serveur, celui-ci la transmet au chef, et le serveur revient avec votre plat. Un appel API fonctionne de la même manière.

Les API remplissent deux fonctions principales :

• Établissement de règles : les API expliquent comment interagir avec elles. Elles définissent les règles pour les développeurs.
• Transfert de données : elles transfèrent efficacement les données entre votre application et le serveur. Cela garantit que vous recevez les données dont vous avez besoin.

Point de terminaison d’API

Un point de terminaison d’API est une URL spécifique qui vous permet d’accéder à une ressource sur le serveur. Il s’agit du point de communication entre un client API et un serveur API, où les requêtes arrivent et les réponses sortent.

Chaque point de terminaison comprend :

• Une URL de point de terminaison
  • Base URL -this remains fixed e.g. https://conversations.esendex.co.uk
  • the endpoint path – this is where you can add configurable parameters which affect the response, acting as filters for your search
• Une méthode HTTP
• Des en-têtes
• Un corps

API REST

Nos APIs utilisent une structure REST (Representational State Transfer), également appelée API RESTful. Cela signifie qu’elles fonctionnent en ligne. Lorsque vous effectuez une requête vers une API REST, vous obtenez toutes les données disponibles.

Aide-mémoire

Avant de commencer, voici quelques termes relatifs aux APIs à connaître :

Terme	Définition
Clé API	Un code d’accès unique composé de lettres et de chiffres qui donne accès à une API
Point de terminaison	L’emplacement/chemin numérique où une API reçoit les requêtes concernant ses ressources
Méthode de requête	Utilise les méthodes HTTP (GET, POST, PUT, DELETE) pour indiquer à l’API ce que vous souhaitez qu’elle fasse
Appel API	Processus par lequel un client (votre ordinateur) envoie une requête API à un serveur
Code d’état	Un code numérique qui apparaît dans le corps d’une réponse API et qui vous indique si votre requête a abouti ou non
Serveur API	Authentifie et traite les requêtes API avant de fournir une réponse appropriée
Réponse API	Une réponse générée par le serveur API et renvoyée au client (votre ordinateur)

Pour en savoir plus sur les APIs, veuillez consulter notre portail développeurs.