# API LABEL COURSIER.FR V3

<table border="1" id="bkmrk-08%2F06%2F2020-version-3" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.3333%;">10/02/2021</td><td style="width: 33.3333%;">[![image-1662457811981.png](https://bookstack.digf.fr/uploads/images/gallery/2022-09/scaled-1680-/image-1662457811981.png)](https://bookstack.digf.fr/uploads/images/gallery/2022-09/image-1662457811981.png)</td><td class="align-right" style="width: 33.3333%;">Version 3.0</td></tr></tbody></table>

##### **Objectif**

Editer une étiquette ou "lettre de voiture" pour une mission donnée. Le document est un pdf encodé en base 64.

##### **Protocole**

Les requests se font en mode https à l’url <u>api.coursier.fr/v3/label.php,</u> on récupère un json contenant un string en base64 du document pdf.

##### **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.

<table id="bkmrk-nom-requis-type-desc" style="width: 0px;" width="614"><tbody><tr><td style="width: 222px;">**NOM**

</td><td style="width: 107px;">**REQUIS**

</td><td style="width: 116px;">**TYPE**

</td><td style="width: 357px;">**DESCRIPTIF**

</td></tr><tr><td style="width: 222px;">User

</td><td style="width: 107px;">O

</td><td style="width: 116px;">Varchar(32)

</td><td style="width: 357px;">User d'accès aux interfaces coursier.fr

</td></tr><tr><td style="width: 222px;">Apikey

</td><td style="width: 107px;">O

</td><td style="width: 116px;">Varchar(32)

</td><td style="width: 357px;">Apikey liée à votre user d'accès aux interfaces coursier.fr

</td></tr><tr><td style="width: 222px;">ClientId

</td><td style="width: 107px;">O

</td><td style="width: 116px;">int

</td><td style="width: 357px;">Numéro de compte client

</td></tr><tr><td style="width: 222px;">MissionNumber

</td><td style="width: 107px;">O

</td><td style="width: 116px;">int

</td><td style="width: 357px;">Identifiant de la course obtenu lors du passage de commande. Si ce paramètre n'est pas spécifié ou vide, l'API retourne l'ensemble des missions à livrer à partir d'aujourd'hui.

</td></tr><tr><td style="width: 222px;">Lang

</td><td style="width: 107px;">N

</td><td style="width: 116px;">varchar(2)

</td><td style="width: 357px;">Code langue pour ma restitution des messages (FR par défaut)

</td></tr></tbody></table>

##### **Réponse JSON 

La réponse est un tableau json contenant les informations relatives à la course ou au fragment interrogé. En cas d'erreur, l'api répond un json contenant un champ Message précisant la nature de l'erreur.

<table id="bkmrk-nom-taille-descripti" style="width: 810px; height: 1066px;"><tbody><tr style="height: 35px;"><td style="width: 225px; height: 35px;">**NOM**

</td><td style="width: 116px; height: 35px;">**Taille**

</td><td style="width: 469px; height: 35px;">**DESCRIPTIF**

</td></tr><tr><td style="width: 225px;">MisionId

</td><td style="width: 116px;">Int

</td><td style="width: 469px;">Id unique de la course, en cas de rupture de charge, il y a plusieurs missionid pour une même course

</td></tr><tr style="height: 79px;"><td style="width: 225px; height: 79px;">MissionNumber

</td><td style="width: 116px; height: 79px;">int

</td><td style="width: 469px; height: 79px;">Numéro de la course, c'est ce numéro qui permet de dialoguer avec notre coursier et le service client

</td></tr><tr><td style="width: 225px;">cmr

</td><td style="width: 116px;">varchar

</td><td style="width: 469px;">Document pdf encodé en base64

</td></tr></tbody></table>

##### **Exemple d'appel**

```PHP
<?php
$Url = "https://api.coursier.fr/v3/label.php";
$Data = array('User' => 'test@apicfr.fr',
			  'Apikey' => 'e1ab1411d66765e73cf4b068d39cda8a',
			  'ClientId' => '7055339',
			  'MissionNumber' => '9024734',
			  '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**

<p class="callout success">string(6816) "\[{"MissionId":"10009998","MissionNumber":"9012345","cmr":"JVBERi0xLjMKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSID4+CmVuZG9iagoyIDAgb2JqCjw8IC9UeXBlIC9PdXRsaW5lcyAvQ291bnQgMCA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzYgMCBSCl0KL0NvdW50IDEKL1Jlc291cmNlcyA8PAovUHJvY1NldCA0IDAgUgovRm9udCA8PCAKL0YxIDggMCBSCi9GMiA5IDAgUgovRjMgMTAgMCBSCi9GNCAxMyAwIFIKPj4KL1hPYmplY3QgPDwgCi9JMSAxMSAwIFIKL0kyIDEyIDAgUgo+Pgo+PgovTWVkaWFCb3ggWzAuMDAwIDAuMDAwIDU5NS4yODAgODQxLjg5MF0KID4+CmVuZG9iago0IDAgb2JqClsvUERGIC9UZXh0IC9JbWFnZUMgXQplbmRvYmoKNSAwIG9iago8PAovUHJvZHVjZXIgKP7/AGQAbwBtAHAAZABmACAAPAA3ADUAZgAxADMAYwA3ADAAPgAgACsAIABDAFAARABGKQovQ3JlYXRpb25EYXRlIChEOjIwMjEwMjEwMTkzMDE3KzAxJzAwJykKL01vZERhdGUgKEQ6MjAyMTAyMTAxOTMwMTcrMDEnMDAnKQovVGl0bGUgKP7/AEwARQBUAFQAUgBFACAARABFACAAVgBPAEkAVABVAFIARSkKPj4KZW5kb2JqCjYgMCBvYmoKPDwgL1R5cGUgL1BhZ2UKL01lZGlhQm94IFswLjAwMCAwLjAwMCA1OTUuMjgwIDg0MS44OTBdCi9QYXJlbnQgMyAwIFIKL0NvbnRlbnRzIDcgMCBSCj4+CmVuZG9iago3IDAgb2JqCjw8IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTU2MCA+PgpzdHJlYW0KeJytWc1S20gQvvMUfUyqkmH+NcNpDYhEWWMTSVCpSnJwOYLSrm0R2WbzHHmSPe8T7GPsMbzF9gj/SLEEBKYoBjGe7p6e+frrbnmPEmso1Mfyak9IQpmGgGqiGAPFA8KlBUYZEVpAmcHl3tc9ExBmDKAccE4UpaACIhTKSUWsFDCewn7E4bjYe4/LUb3iDEdK6WZ0M8IqYpSEQFlCpUKxPWCNVW58XZ8Sd39wJYO/0P47/P0DbdAdMfTmF5fUP+J1a2W2d1l58qAK83wVjNc+00/TwakHHR58EdyDDv18X6QHX5SHe9EeIKalBx0eziPwcC9GPl+H9YAxq5+vg1EPQceYB28Y8+GODw5hPkiE+WARJn2444NHmA8iYT6YhPmgEhb4uB0fZMJ8sAmzXtKvB7BxH1TAfVABb1DBk5V4ABv3wSfcR0XBpQ93Gnzy1J0oH1fsgwq49uGODyrg5iF33E+rmsMUJOJdMIrdDCdMBZB+gf0TBpYYSC8BPr4Y/APH34fxcRwevPwM6TsI00rOCCIV65azlMtAyLqMQzTHtdowwrW+k+HABFEroX6YpnEIxyFcDKP0PA434pQY63a+HXH/u5Pxm3Vbp7E9E0bCFJR25uRmZlKb0YQJN7MRWk9g79d1ZOu1SmL/F6y92HoeDU6G8WkvjYaDpLb/tg5UV+eg8FwCnOHYGppAYgca4IpVB9p5cZpozUAziWcqd3eRxr1BcjaM0/A8hubVrSQpYkXK3Zs7Gp7HSRTG5CRuEVMGV4oWMUXhMJ9DuczgdLQs83EGvXJWLL+BRXqncFrMFmWxvMralAYB0bzNi2zS3Ly2RLKgKVDfBUVlCtEJaJHSNlNaoYYWU6ej/CdbAR6t5U2Juq18dln8Ni6W5TzPSnJZtllTgnDaIptEcYirUC1HdwzluFuqDbyG9KIHB3ASg1X1z+9HEreWYNn3NCgJaokSqhtLR/0oHKTNw9kIPQJGkJyfhfFFlGBItOloYKorlOC+XXQC6Pj2elQusmk2WzQFA0UokkEnkIKACyS3VmNdEBr8DV8yGBfT6WiGD/lskZWzrBl83BLLTDeolGRGcH0/8a0oSFpHV7rGceuZSWPGGL3luO3EwxynqCRYr+562sN8kCTh4/hNuHdoLiQ3oGToCHsUv0kMeBWo3R2Eg354EZ7uIGIt597SabV7vmmYpG3rMTkw1bJeKoiR0iYjOCxuF3n2CgJFqYGzUZnPX8FJOZqN2yhNYidnZYvCmnibGObjQLSIDYpFBa3rya0D8yjH02t1nBqieNuBzSY/bqpAgEkGdUnGMAaQvhuiddvc7FO2zylngOJomIkDQSFbAJP48DhqehIK1iHXCYN+dBH3omQ4aOeFR8NgI+ANBxuNvwiEjdyTkbDR0AWFfn5TjvJ5MfsZCUK7u9K/ggR5QO+QoA8ofRRrCbwTLLRqrLWemdRmDBG2xlrbiYdZS2CBz1pTfC8+etsbHEdJ+ABxrRRRBIPRm68G3Bt/GtyPWMwnAvldIM8b1nL279OwEXsB1s+GgXAo0bYlp/QadbAro13qoLg7YQkN2nJehLSYVDmzIRcYTDkCt4YJQLfIfXrR/9D/8PbTy2aiRO/Qkc4Nng2j4wTSYdrrNxsETjheQqccFqhHv0eDN3UhbGW0oBWAmbG78GONo1MKaQt3xjBQ1u1EowIpJliQzpfl62mGYyM6sc7B4k53C3M1nsI3YNXo/mkcijEVS3RKU6Lon1ePCgfXjgpNa+GwnpnUZhCIjG7DYTvxcDhw7Qi3pVE5QoREbwZhAme9OI2OzvvRv3EjpyPj3jWaHwE+48MXt2mBpI0kgeWTiwxNpLWYQrDOVa7jhKQ6XobllcImCUPKGmc6qL47S8fVQbnXPV3dxp0HuHB1UUhFLl0oSjRdnbTAXnkDo2KJdDj5fvt1mV9nUK86b4ol9iOY8spxnrnK7KZwlDUuZpe5Y2tS89TxBY7cuhF71LsTZNJFscE6vN14OIPxaO5UT/JFfpVBZeuuCERmHmP9B7PK6Dwrb1xLNLouf8zhBskTn5fQbFegWAKWqzB1rch/0NVf/A8OmjJvCmVuZHN0cmVhbQplbmRvYmoKOCAwIG9iago8PCAvVHlwZSAvRm9udAovU3VidHlwZSAvVHlwZTEKL05hbWUgL0YxCi9CYXNlRm9udCAvSGVsdmV0aWNhCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago5IDAgb2JqCjw8IC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovTmFtZSAvRjIKL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTAgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMwovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iagoxMSAwIG9iago8PAovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvSW1hZ2UKL1dpZHRoIDIxNwovSGVpZ2h0IDU2Ci9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9EZWNvZGVQYXJtcyA8PCAvUHJlZGljdG9yIDE1IC9Db2xvcnMgMSAvQ29sdW1ucyAyMTcgL0JpdHNQZXJDb21wb25lbnQgOD4+Ci9Db2xvclNwYWNlIC9EZXZpY2VHcmF5Ci9CaXRzUGVyQ29tcG9uZW50IDgKL0xlbmd0aCAxMzExPj4Kc3RyZWFtCmiB7ZpfZCNbHMcjIiIqYkVEVUTVqFV11VW11rVWVdSqPkTsU62q61pVVRW1qmqtiLjGtaquiIhVfbgqotaoqKjqQ1WMiIqqiqoaVVFVERHjuDOTc85M2pnMNolMspvPQ8Y5vpP5fXPO+Z0/E53uObwgxqYWghHqkKYvGZ7rNJ3c3fC5B03P+p42Qz++nb4uAjlYJjmldXh1Y/GeyJrC5kIvtA6xTlzTXhUIrUPs0vnox9W62Q/zh9ZeqpmTT3f1cK3X2oyUgVzTjIGHXq3dSNlpnjFQGNTaTZefELNVDoW1oQULLK2Nsg56vtEypN7Jq0XxYVvlRjmIW7n8cOOSV2ewItPSKOthVjbzRRXU91ix1cog62J+W46X8mKjqJhubZhdfjEG3YgJu9axNBcKZ4eH11rH0lSMBTHnO7UOpqkMMphjg6LK0ud09vWIZVOv0+kUT0X0DmHxYnKYUYXdwWE3i3cY7FV39NjRlG9xCKDFjVEo2apC0duESissmisSo4ozM4FRbrLZk/Nc7uIYbztfH5xx5fQCKvdmhdlgOjsDK/rpLM/JLFJYY1nujswi8rOcQoP6b0GZXYfFt0LpNDkqebzrUKgMweJcRUI14VRmCuSiJBlj4yhu9mabJEPn5RH0aPCBv8wA5PVl4YKb/OK3t+h33irF1nyBa8YBy0G80dsu/EtyePGzUtyde8VjyQqVYK54yZ+w6GMTnGS/lGjc2dcS3ySG0zNYngVL/KXvHlmVcRbmW2cZvIEVt2m+Z64C1C8kzpiqlDwF5rlP4/G1pAcRTFIq8RX5BjUkS0rxvo9UE1AS6reEr9LNf4YVq2BSuJ7mVJxNQ6FOl8/wrWf7DQ0OFWc66qZfxZkuCpTijT9aNH5Xcmb4rzhaVbEGKiOOVnPmB0OwIl4+CK78NYmTkMTZw2cfB9qrV5yZ6AvJsQTBZGc4UN+vONPTeYV4rY8PhJXbbLsOZ+mA3x8r7aENnzV2lmPybMb21Fn5nE8Ibuws4feT+/ekJPURTPmOYw05K0c5yfH9ipKzwKPe+EbRWfiJswlVZ3luM3fLhnH2NjpcxBAJPE+d3QzxSRz9BFPgiqbThcJHyfMI5mSYA2UfH3tG05niXRNW56GisDoJoI69CgM8RynFBYT0/gGgeCq90XRUgDOYaXNZL+iWnjqTG2f9V7TkHYLsOHM+0A3a4lhnhYgPi7A8A/z8ZagUhhW2ys7uC3gPK+A4+wTgvshwl+YbZRLMQYGKM306K6mVzyBpplbMBnGe7ldWjd4VE5FoCqAJxHnJHkQicTY/gBQpwFUkynmUB6AzH84gm+wB6f+Wv0N3SJyV9ikO1I9hbqQrzsZLXkVndE1nkrVVrIZsZPOAphNBbN61TqXo5NcxLCCC+5yARD50ztgif/FQLljRs/Q9RR9tudEaZDaGcomPoqTOxijhNd1GSJjjR3b5XNW3VZXdPHHhB9youb+fFlPjP7V0nYdPdOZVV3cSBN52utv/JLHLz41lhUR8VJAYsIJ81dLYGsN1iRNIXEHySswxwy2NrTEGxDPwpIJkXTwmafsjfQmuI/wqYldeYYhgxWZrY2sMvfrrI1FhVlB06dIUHGnZl02yfNI62GdhptQdQS46bJitq1uqwC5qHeoz6f3RfyV5ugvmLi2A8Kj1xIkOSx4IO6mSO2LDym+f2pzhncuygq38afh3rcNrBIPrrS+6l8owDHPDcn7K/H/Zj3Y2FiaGbOp3a8f/6OkVBAplbmRzdHJlYW0KZW5kb2JqCjEyIDAgb2JqCjw8Ci9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9JbWFnZQovV2lkdGggMjE3Ci9IZWlnaHQgNTYKL1NNYXNrIDExIDAgUgovRmlsdGVyIC9GbGF0ZURlY29kZQovRGVjb2RlUGFybXMgPDwgL1ByZWRpY3RvciAxNSAvQ29sb3JzIDMgL0NvbHVtbnMgMjE3IC9CaXRzUGVyQ29tcG9uZW50IDg+PgovQ29sb3JTcGFjZSAvRGV2aWNlUkdCCi9CaXRzUGVyQ29tcG9uZW50IDgKL0xlbmd0aCA1OD4+CnN0cmVhbQp4nO3BMQEAAADCoPVPbQ0PoAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAeDCOoAABCmVuZHN0cmVhbQplbmRvYmoKMTMgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GNAovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iagp4cmVmCjAgMTQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNzQgMDAwMDAgbiAKMDAwMDAwMDEyMCAwMDAwMCBuIAowMDAwMDAwMzQ0IDAwMDAwIG4gCjAwMDAwMDAzODEgMDAwMDAgbiAKMDAwMDAwMDU4NiAwMDAwMCBuIAowMDAwMDAwNjg5IDAwMDAwIG4gCjAwMDAwMDIzMjIgMDAwMDAgbiAKMDAwMDAwMjQyOSAwMDAwMCBuIAowMDAwMDAyNTQxIDAwMDAwIG4gCjAwMDAwMDI2NTEgMDAwMDAgbiAKMDAwMDAwNDIwNyAwMDAwMCBuIAowMDAwMDA0NTIxIDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgMTQKL1Jvb3QgMSAwIFIKL0luZm8gNSAwIFIKL0lEWzw5ZTQ0OWM1N2Y3YTM0Mjc3N2NkMDkzNGJlY2E3ZTgwMT48OWU0NDljNTdmN2EzNDI3NzdjZDA5MzRiZWNhN2U4MDE+XQo+PgpzdGFydHhyZWYKNDYzMQolJUVPRgo="}\] "</p>

Vous pouvez tester le document reçu à l'aide d'un décodeur base64 online, ex : [https://base64.guru/converter/decode/pdf](https://base64.guru/converter/decode/pdf)

##### Exemple de document cmr

[![cmr.png](http://bookstack.digf.fr/uploads/images/gallery/2021-02/scaled-1680-/cmr.png)](http://bookstack.digf.fr/uploads/images/gallery/2021-02/cmr.png)