Protocole

Le protocole à utiliser pour tous les appels à l’API est https.

Encodage

Les URIs d’appel à l’API v1 sont construites d’après le modèle suivant :

https://www.envoimoinscher.com/api/v1/[/][.../chemin/.../]/ressource

La langue par défaut est « fr », c’est la seule langue disponible à l’heure actuelle. C’est la langue des noms de paramètres à fournir dans les requêtes et des libellés des réponses. Par contre, les noms des ressources et les balises des documents XML de réponse sont toujours en anglais. Se référer à l’annexe pour une correspondance entre les noms français des paramètres et les balises en anglais associées.
L’URI doit être en minuscules.

Formats des URLs

Les requêtes sont à réaliser en GET (pour une consultation de ressource, une cotation) ou en POST (pour une commande). Les paramètres sont à fournir dans le chemin de l’URI pour les requêtes GET de type ‘dictionnaire’, et avec une chaîne de requête (« query string ») spécifiant la valeur de chacun d’eux pour les requêtes GET ou POST de cotation ou de prise de commande.

Formats des requêtes

Les requêtes sont à réaliser en GET (pour une consultation de ressource, une cotation) ou en POST (pour une commande), avec une chaîne de requête (« query string ») spécifiant la valeur de chacun des paramètres fournis..

Formats des réponses

Toutes les réponses sont au format XML, sans attributs.

Codes de retour

Le code de retour HTTP peut être :

200 : succès
400 : requête invalide
401 : accès interdit
404 : ressource non trouvée
500 : erreur interne du serveur

En cas d’erreur, le corps de la réponse est un document XML structuré comme suit :

<error>
<code>code de l'erreur</code>
<message>message associé</message>
</error>

Authentification

Chaque requête API nécessite la présence d’un en-tête authentification HTTP basic composé du login et du mot de passe que vous utilisez sur le site. En plus de cela, il faut rajouter une en-tête access_key dont la valeur correspond à la clé API attachée à votre compte.

Type des environnements

L’API est disponible sur deux serveurs : de production et de test. Dans la première phase de développement il vous est conseillé de travailler uniquement avec le serveur de test. Les commandes que vous allez passer sur ce serveur sont factices et en conséquence vous ne serez pas facturés. Le serveur de test pointe vers https://test.envoimoinscher.com .

Par contre, toutes les commandes passées sur le serveur de production sont bien réelles. Vous serez facturés. Le serveur de production pointe vers https://www.envoimoinscher.com .

Paramètres

Dans la réponse de cotation vous pouvez obtenir les éléments qui contiennent les informations facultatives à fournir, entre autres, pour les options. Chaque noeud est composé du code, libellé et type. Ce dernier détermine quel type de données est attendu par l’API. Les types possibles retournés dans la réponse sont :

  • string – une chaîne de caractères
  • float – un nombre en virgule flotante
  • boolean – true ou false
  • enum – une liste de valeurs, qui peuvent être des identifiants renvoyant à un dictionnaire de données

ans d'expertise

clients satisfaits

de colis envoyés
Des questions ?

Nos experts sont à votre écoute