Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Création d’une demande
1. Introduction
Cette API permet de créer une demande pour l'envoi de colis. Elle est conçue pour les utilisateurs qui souhaitent
intégrer cette fonctionnalité dans leurs systèmes ou applications.
2. Authentification
L’API utilise le mécanisme d’authentification Bearer Token. Chaque requête doit inclure un en-tête avec un token
valide pour être acceptée.
• Clé : Authorization
• Valeur : Bearer tPWZwgv9qPl6RM
Exemple d’en-tête HTTP :
Authorization: Bearer tPWZwgv9qPl6RM
3. Endpoint : Création d'une demande
Cet endpoint permet de créer une nouvelle demande d'envoi de colis.
URL : http://ip_adress/api/v1/creer_demande
Méthode HTTP : POST
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Paramètres requis :
Nom Type Obligatoire Description
generer_barcode Boolean Non Indique si un code-barres doit être
généré par système Sapress.
inclus_colis Boolean Non Indique si les colis doivent être inclus si
vous voulez avoir les numero de colis dans
la trame de la réponse.
prefix_codebar String Non Préfixe à utiliser pour le code-barres.
data Array Oui Liste des détails des colis à inclure dans
la demande.
Exemple de requête :
curl --location 'http:// ip_adress/api/v1/creer_demande' --header 'Content-Type: text/plain' --header
'Authorization: ••••••' --data-raw '{"generer_barcode": true, "inclus_colis": true, "prefix_barcode": "MAMDA",
"data": [{"modele": "( 50.0 * 50.0 * 50.0 )","poids_colis": 5,"type_colis": "Colis","methode_contre_remboursement":
"Espèces","montant_contre_remboursement": "620.00","expediteur_name": "Cliant 1","destinataire_name": "TEST
1", "adresse": "Oujda9. 00 الشرفي الملعب طريق. الرضوان حي."رقم اللؤلؤ زنقة, "valeur_declaree": 3, "zip": 5473,
"email": "[email protected]", "telephone": "0700925999", "destination": "Oujda", "nature_marchandise": "",
"ref_externe": "#123", "barcode":"" } ] }'
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Exemple de réponse :
4. Tester l’API
Pour tester l’API :
1. Configurez la méthode HTTP à POST.
2. Ajoutez l’en-tête suivant :
- Clé : Authorization
- Valeur : Bearer tPWZwgv9qPl6RM
3. Fournissez l’URL de l’endpoint avec les données dans le corps de la trame.
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Archivage d’une demande par numéro
1. Introduction
Cette API permet de d’archiver une demande en utilisant son numéro. Elle est conçue pour les utilisateurs qui
souhaitent intégrer la fonctionnalité d’archivage dans leurs systèmes ou applications.
2. Authentification
L’API utilise le mécanisme d’authentification Bearer Token. Chaque requête doit inclure un en-tête avec un Token
valide pour être acceptée.
• Clé : Authorization
• Valeur : Bearer tPWZwgv9qPl6RM
Exemple d’en-tête HTTP :
Authorization: Bearer tPWZwgv9qPl6RM
3. Endpoint : Archivage d’une demande
Cet endpoint permet d’archiver une demande par un numéro donné.
URL : http://ip_adress/api/v1/archiver_demande/{numero_demande}
Méthode HTTP : POST
Paramètre requis :
Nom Type Obligatoire Description
numero_demande String Oui Numéro de la demande.
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Exemple de requête avec curl:
curl --location --request POST ‘http://ip_adress /api/v1/archiver_demande/DM24111335096' --header
'Authorization: ••••••'
Exemple de réponse :
• Code 200: Succès
4. Tester l’API
Pour tester l’API :
1. Configurez la méthode HTTP à POST.
2. Ajoutez l’en-tête suivant :
- Clé : Authorization
- Valeur : Bearer tPWZwgv9qPl6RM
3. Fournissez l’URL de l’endpoint avec le numéro de colis.
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Tracking de Colis par numéro
1. Introduction
Cette API permet de suivre l’état d’un colis en utilisant son numéro de colis. Elle est conçue pour les utilisateurs qui
souhaitent intégrer la fonctionnalité de suivi dans leurs systèmes ou applications.
2. Authentification
L’API utilise le mécanisme d’authentification Bearer Token. Chaque requête doit inclure un en-tête avec un Token
valide pour être acceptée.
• Clé : Authorization
• Valeur : Bearer tPWZwgv9qPl6RM
Exemple d’en-tête HTTP :
Authorization: Bearer tPWZwgv9qPl6RM
3. Endpoint : Suivi d’un colis
Cet endpoint permet de récupérer les informations de suivi pour un Colis par un numéro donné.
URL : http://ip_adress/api/v1/trackingcode/{tracking_number}
Méthode HTTP : GET
Paramètre requis :
Nom Type Obligatoire Description
tracking_number String Oui Numéro unique du colis à suivre.
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Exemple de requête avec curl:
curl -X GET http:// {ip_adress }/api/v1/trackingcode/{tracking_number} -H "Authorization: Bearer
45QcqvdbhK9JQ5"
Exemple de réponse :
• Code 200: Succès
4. Tester l’API
Pour tester l’API :
1. Configurez la méthode HTTP à GET.
2. Ajoutez l’en-tête suivant :
- Clé : Authorization
- Valeur : Bearer tPWZwgv9qPl6RM
3. Fournissez l’URL de l’endpoint avec le numéro de colis.
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Tracking de colis par code à barre
1. Introduction
Cette API permet de suivre l’état d’un colis en utilisant son code à barre. Elle est conçue pour les utilisateurs qui
souhaitent intégrer la fonctionnalité de suivi dans leurs systèmes ou applications.
2. Authentification
L’API utilise le mécanisme d’authentification Bearer Token. Chaque requête doit inclure un en-tête avec un token
valide pour être acceptée.
• Clé : Authorization
• Valeur : Bearer tPWZwgv9qPl6RM
Exemple d’en-tête HTTP :
Authorization: Bearer tPWZwgv9qPl6RM
3. Endpoint : Suivi d’un colis
Cet endpoint permet de récupérer les informations de suivi pour un Colis par un code à barre donné.
URL :
http://ip_adress/api/v1/trackingbarcode/{barcode_number}
Méthode HTTP : GET
Paramètre requis :
Nom Type Obligatoire Description
barcode_number String Oui Code à barre du
colis à suivre.
Documentation API V1 Date de dernière
mise à jour :
19/11/2014
Exemple de requête :
curl -X GET http://ip_adress/api/v1/trackingbarcode/{barcode_number}\
-H "Authorization: Bearer 45QcqvdbhK9JQ5"
Exemple de réponse :
• Code 200: Succès
4. Tester l’API
Pour tester l’API :
1. Configurez la méthode HTTP à GET.
2. Ajoutez l’en-tête suivant :
- Clé : Authorization
- Valeur : Bearer tPWZwgv9qPl6RM
3. Fournissez l’URL de l’endpoint avec le code a barre du colis.
