API INFO COURSIER.FR V3

12/11/2020

Version 3.1

Objectif

Pouvoir ajouter des informations complémentaires dans le dossier d'une mission. Cela concerne notamment toute précision, ou consigne apportée par le client après le passage de la commande. On peut également utiliser cette api pour partager les interactions du client final avec le call center du client pour tenir informé coursier.fr de tous les évènements de la commande, cela facilite notre intervention en cas de difficulté de livraison ou lorsque l'on a le client au téléphone.

Cela ne concerne pas une modification d'horaire ou d'adresse qui peuvent avoir un impact tarifaire et qui nécessitent donc d'annuler la course et d'en reprogrammer une nouvelle.

Protocole

Les requests se font en mode https à l’url api.coursier.fr/v3/comment.php, on récupère un json avec un statut et un message en cas d'erreur. Dans le cas d'une rupture de charge, il peut y avoir plusieurs missions côté coursier.fr, dans ce cas le commentaire est apporté aux deux missions.

 

Authentification

L'authentification se fait à l'aide d'une apikey associée à votre user coursier.fr, vous pouvez trouver ces informations dans votre espace client. Vous devez disposez d'un compte en facturation mensuelle, si ce n'est pas encore le cas vous pouvez contacter un commercial à l'adresse commercial@coursier.fr. Vous devez passer en paramètre l'apikey, le user et le compte client utilisé, un même user pouvant être rattaché à plusieurs comptes client.

Afin de tester nos apis, vous pouvez utiliser le compte de test suivant pour réaliser vos développements dès à présent en attendant d'avoir vos accès définitifs :

User : test@apicfr.fr

Pass : T3stCFR*

ClientId : 7055339

Apikey : e1ab1411d66765e73cf4b068d39cda8a

Paramètres 

Les paramètres sont à passer en POST sous forme d’un tableau json.

NOM	REQUIS	TYPE	DESCRIPTIF
User	O	Varchar(32)	User d'accès aux interfaces coursier.fr
Apikey	O	Varchar(32)	Apikey liée à votre user d'accès aux interfaces coursier.fr
ClientId	O	int	Numéro de compte client
MissionNumber	O	int	Identifiant de la course obtenu lors du passage de commande.
Comment	O	Varchar(1000)	Message d'information à ajouter au dossier de la mission
Lang	N	varchar(2)	Code langue pour la restitution des messages (FR par défaut)

Réponse JSON 

La réponse est un tableau json aavec un statut (OK/NOK) et un message descriptif en cas d'erreur.

NOM	Taille	DESCRIPTIF
Status	varchar(3)	OK ou NOK
Message	Varchar(1000)	En cas d'erreur description de la nature de l'erreur

Exemple d'appel

<?php
$Url = "https://api.coursier.fr/v3/comment.php";
$Data = array('User' => 'test@apicfr.fr',
			  'Apikey' => 'e1ab1411d66765e73cf4b068d39cda8a',
			  'ClientId' => '7055339',
			  'MissionNumber' => '9005657',
			  'Comment' => 'Le client sera peut-être absent, dans ce cas laiser le colis au voisin au n°122 de la rue' 
              'Lang' => 'FR',
			 );

$datajson = json_encode($data);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $datajson);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$res = curl_exec($curl);
curl_close($curl);
var_dump($res);
?>

Exemple de réponse

[{"Status":"OK","Message":""}]