Esendex API

Introduction

La nouvelle API Esendex, (interface de programmation) simple et légère, repose sur des standards simples et éprouvés, ce qui limite le recours à des kits d'outils spéciaux. Cela signifie qu'Esendex peut prendre en charge une gamme plus étendue de langages de programmation qu'auparavant.

Le document de support décrit l'approche «RESTful» que propose l’API aux services de communications commerciales fournis par Esendex. Il a pour but de fournir toutes les informations nécessaires pour commencer à utiliser l’API.

Documentation API Esendex

L'API Esendex est basée sur le style architectural de REST et est implémentée sur le protocole HTTP. Elle utilise les méthodes standard HTTP de GET, POST, PUT et DELETE pour interagir avec un ensemble de ressources définies. Les requêtes et les réponses de l'API REST sont des représentations XML encodées UTF-8.
De manière à pouvoir utiliser l'API Esendex, les éléments suivants sont nécessaires :

• Une connexion Internet active
• Une gestion des objets de requête/réponse HTTP
• Des fonctions d'analyse XML

Méthodes HTTP

Il y a quatre méthodes ou verbes principaux qui sont utilisés pour interagir avec l'API Esendex. Ce sont GET, POST, PUT et DELETE.

L'utilisation de ces verbes décrit les opérations sur une ressource de la manière suivante :

• GET
  • Récupère une représentation de la ressource requise (état actuel)
• POST
  • Crée une nouvelle occurrence d'une ressource
• PUT
  • Met à jour une occurrence existante d'une ressource
• DELETE
  • Supprime une occurrence existante d'une ressource

Démarrage rapide

Les deux tâches de base d'envoi et de réception de messages ont été introduites ici pour aider à rapidement identifier les ressources nécessaires pour exécuter ces opérations principales.

Utilisation de l'API Esendex

Chaque interaction avec l'API Esendex suit les mêmes étapes de base :

1. Collecter toutes les données nécessaires pour effectuer la requête.
2. Construire une requête HTTP. Assurez-vous d'inclure l'entête Authentication et tout autre paramètre de données supplémentaire.
3. Invoquez la requête HTTP à l'URI de ressource appropriée en utilisant la méthode HTTP supportée.
4. Récupérez la réponse HTTP et anlysez-la.
5. Si nécessaire, utilisez les données de réponse afin de continuer à effectuer d'autres opérations.

Envoi de messages

Pour envoyer des messages, vous aurez besoin d'utiliser la ressource Message Dispatcher. Une valeur unique GUID (identificateur unique) sera affectée à chaque message envoyé avec succès via Esendex. Cette ID peut être utilisée pour récupérer plus tard les détails du message, comme sont état de livraison via la ressource Message Headers.

Réception de messages

Pour recevoir des messages, vous pouvez récupérer (retirer) les messages de votre ressource Inbox ou utiliser le mécanisme de notification Push Account Event Handler.

Par exemple, récupérer votre message de réception est aussi simple que de faire une requête GET sur http://api.esendex.com/v1.0/inbox/messages