Introduction

L'API easyReco permet de faire communiquer votre système de gestion, ERP, ou solution ad-hoc avec notre solution.
Les usages peuvent être divers, vous pouvez par exemple préparer des envois et récupérer les PDF d'impression ou les documents de dépôts...
Les flux de données passent par des requêtes HTTPS : POST, GET ou DELETE.
Vous trouverez dans cet espace les différentes méthodes et options vous permettant d'utiliser ce service.

Préparer un envoi

RequestListe de paramètresResponseCodes erreurCommentaire
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//POST https://api.easyreco.com/envois
//JSON
 
  {    "envoi":{ //on définit d'abord les paramètres de l'envoi
      "id_utilisateur":1234,
      "descriptif":"",
      "id_support": 1,
      "plis":[ //on définit ensuite les paramètres de chaque pli
        {
          "pli":{ //paramètres du premier pli
            "id_code_imputation": 101,
            "id_utilisateur_imputation": 11,
            "expediteur": {
              "raison_sociale": "UXEN",
              "nom": "",
              "complement_voie": "",
              "voie": "26 RUE GEORGE SAND",
              "boite_postale": "",
              "code_postal_commune": "75016 PARIS",
              "pays": "FRANCE"
            },
            "destinataire": {
              "raison_sociale": "DEMO SAS",
              "nom": "M DEMO JEAN",
              "complement_voie": "",
              "voie": "10 RUE DES LILAS",
              "boite_postale": "",
              "code_postal_commune": "33000 BORDEAUX",
              "pays": "FRANCE"
              "code_pays": "FR"
            },
            "retour_ar": {
              "raison_sociale": "UXEN",
              "nom": "",
              "complement_voie": "",
              "voie": "26 RUE GEORGE SAND",
              "boite_postale": "",
              "code_postal_commune": "75016 PARIS",
            },
            "reference": "Réf du 1er pli",
            "options": 1,
            "options_notification": 0,
            "poids": 0,
            "valeur_declaree": 0,
          }
        },
        {
          "pli":{ //paramètres du second pli
            "id_code_imputation": 101,
            "id_utilisateur_imputation": 11,
            "expediteur": {
              "raison_sociale": "UXEN",
              "nom": "",
              "complement_voie": "",
              "voie": "26 RUE GEORGE SAND",
              "boite_postale": "",
              "code_postal_commune": "75016 PARIS",
              "pays": "FRANCE"
            },
            "destinataire": {
              "raison_sociale": "DEMO SAS",
              "nom": "MME DEMO SOPHIE",
              "complement_voie": "",
              "voie": "10 RUE DES LILAS",
              "boite_postale": "",
              "code_postal_commune": "33000 BORDEAUX",
              "pays": "FRANCE"
              "code_pays": "FR"
            },
            "retour_ar": {
              "raison_sociale": "UXEN",
              "nom": "",
              "complement_voie": "",
              "voie": "26 RUE GEORGE SAND",
              "boite_postale": "",
              "code_postal_commune": "75016 PARIS",
            },
            "reference": "Réf du 2eme pli ",
            "options": 2,
            "options_notification": 0,
            "poids": 0,
            "valeur_declaree": 0,
          }
        }
      ]
    }
  }

Paramètre

Obligatoire

Définition

id_utilisateur

oui

numéro d'ID du compte easyReco lié

descriptif

non

descriptif de l'envoi

id_support

oui

définit le type d'envoi et le support postal associé. Voir nomenclature

id_code_imputation

non

définit le code auquel sera imputé le pli

id_utilisateur_imputation

non

définit le code utilisateur auquel sera imputé le pli

raison_sociale

non

raison sociale de l'expediteur, destinataire ou retour d'AR selon balise parente

nom

non

civilité nom et prénom de l'expediteur, destinataire ou retour d'AR selon balise parente

complement_voie

non

complément voie de l'expediteur, destinataire ou retour d'AR selon balise parente

voie

oui

voie de l'expediteur, destinataire ou retour d'AR selon balise parente

boite_postale

non

boite_postale de l'expediteur, destinataire ou retour d'AR selon balise parente

code_postal_commune

oui

code postal et commune de l'expediteur, destinataire ou retour d'AR selon balise parente

pays

non

pays du destinataire

code_pays

non

code pays ISO du destinataire

reference

non

reference client du pli, pouvant être imprimé si le support le permet

options

oui

options spécifiques du pli. Voir nomenclature

options_notification

non

options spécifiques au système de notification par email d'easyReco. Voir nomenclature

poids

non

spécifique aux supports nécessitant cette valeur. S'exprime en grammes

valeur_declaree

non

spécifique aux supports nécessitant cette valeur. S'exprime en euros

 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

//JSON
 
  {    "envoi":{
      "id":1234,
      "plis":[
        {
          "pli":{
            "id": 1
          }
        },
        {
          "pli":{
            "id": 2
          }
        },
      ]
    }
  }

Code

Intitulé

Définition

200

OK

le processus s'est correctement déroulé

400

BAD REQUEST

erreur dans la requête envoyée à l'API, consulter détail fourni par l'API

401

UNAUTHORIZED

erreur d'authentification à l'API

404

NOT FOUND

l'API demandée n'existe pas

500

INTERNAL SERVER ERROR

une erreur est survenue coté API, consulter détail fourni par l'API

Cette API utilise la méthode POST.
Elle permet de créer un envoi d'un ou plusieurs plis. Un envoi est un ensemble de plis ayant des caractéristiques communes (support, descriptif).
Pour être créé, l'envoi doit contenir à minima un pli. Chaque pli est défini par son imputation, par les données d'adresses expéditeur, destinataire (et éventuellement retour d'AR) qui le compose, ainsi que par les références, options et données facultatives complémentaires.
L'API répond en donnant l'ID unique de l'envoi, ainsi que les ID de chacun des plis ainsi créés.

Obtenir le PDF d'un envoi

RequestListe de paramètresResponseCodes erreurCommentaire
1
2

//GET https://api.easyreco.com/envois/1234
//Accept : PDF

Paramètre

Obligatoire

Définition

id_envoi

oui

numéro d'ID de l'envoi dont on souhaite obtenir le PDF d'impression

Récupération du fichier PDF d'impression des supports des plis de l'envoi

Code

Intitulé

Définition

200

OK

le processus s'est correctement déroulé

400

BAD REQUEST

erreur dans la requête envoyée à l'API, consulter détail fourni par l'API

401

UNAUTHORIZED

erreur d'authentification à l'API

404

NOT FOUND

l'API demandée n'existe pas

500

INTERNAL SERVER ERROR

une erreur est survenue coté API, consulter détail fourni par l'API

Cette API utilise la méthode GET.
Elle permet d'obtenir le PDF d'impression des supports d'envoi d'un ou plusieurs plis. Un envoi est un ensemble de plis ayant des caractéristiques communes (support, descriptif).
Pour être créé, l'envoi doit contenir à minima un pli. L'envoi et les plis contenus dans l'envoi doivent être créé au préalable via l'API Préparer un envoi.
L'API répond via le fichier PDF correspondant à la demande.