Guide d’intégration Services Amana Guide d’intégration Services Amana 0 Guide d’intégration Services Amana Historique des versions __________________________________________________________________ 2 Introduction ___________________________________________________________________________ 3 Liste des Services et API Amana____________________________________________________________ 4 SERVICE D’IMPORT EN MASSE (F.I.M SHIPMENT) ___________________________________________________ 5 Description du service F.I.M _____________________________________________________________________________ 5 Format du F.I.M ______________________________________________________________________________________ 5 Protocole d’Echange ___________________________________________________________________________________ 6 CODES A BARRES (LABELLING) __________________________________________________________________ 7 Description du Service Labelling __________________________________________________________________________ 7 Règles de génération du Labelling ________________________________________________________________________ 7 Exemple _____________________________________________________________________________________________ 7 API POINT RELAIS (PICKUP) _____________________________________________________________________ 8 Description du service Pickup ____________________________________________________________________________ 8 URL du service ________________________________________________________________________________________ 8 Méthodes ___________________________________________________________________________________________ 8 Méthode GetPudoAmana ____________________________________________________________________________ 8 Paramètres en entrée _____________________________________________________________________________ 8 Structure de la Réponse ___________________________________________________________________________ 9 Exemple d’appel __________________________________________________________________________________ 9 Exemple de réponse _____________________________________________________________________________ 10 API TRACKING TEMPS REEL (AMANA TRACKING R.T) _______________________________________________ 11 Description du Service Amana Tracking R.T ________________________________________________________________ 11 Url du service _______________________________________________________________________________________ 11 Méthodes __________________________________________________________________________________________ 11 Méthode « ri_envoi» : Dernier statut du colis ___________________________________________________________ 11 Paramètres en entrée : ArgInput ____________________________________________________________________ 11 Structure de la Réponse __________________________________________________________________________ 11 Exemple d’appel _________________________________________________________________________________ 12 Exemple de réponse _____________________________________________________________________________ 12 Méthode « ri_envoi_oper» : Historique des opérations ___________________________________________________ 12 Paramètres en entrée : ArgInput ____________________________________________________________________ 12 Structure de la Réponse __________________________________________________________________________ 12 Exemple d’appel _________________________________________________________________________________ 13 Exemple de réponse _____________________________________________________________________________ 13 TRACKING EN MASSE (AMANA BULK TRACKING) __________________________________________________ 14 Description du Service Amana Bulk Tracking _______________________________________________________________ 14 Formats disponibles __________________________________________________________________________________ 14 Protocole d’Echange __________________________________________________________________________________ 14 TRACKING via le Service AMANA RICH TRACKING_________________________________________________________ 15 Spécification de l’étiquette Amana ________________________________________________________ 16 1 Guide d’intégration Services Amana Les dimensions de l’étiquette : _________________________________________________________________ 16 Les composants de l’étiquette : ________________________________________________________________ 17 Abréviations et Terminologie __________________________________________________________________ 18 Caractéristiques des champs __________________________________________________________________ 18 Le transporteur ______________________________________________________________________________________ 18 Informations de l’expéditeur ___________________________________________________________________________ 18 Informations du colis et les services optionnels ____________________________________________________________ 19 Informations du destinataire ___________________________________________________________________________ 19 Information de distribution ____________________________________________________________________________ 20 Règles de gestion : ___________________________________________________________________________ 23 Description du Code à Barres __________________________________________________________________ 24 Description du Code QR ______________________________________________________________________ 24 Historique des versions Version Date Désignation Auteur 1.0 01/01/2019 Création du document DCSI/DIMOS 2.0 03/06/2019 Evolution de l’API Amana tracking- DCSI/DIMOS pour prendre en charge le besoin spécifique d’un client 2 Guide d’intégration Services Amana Introduction Ce document décrit la liste des services Amana et le guide d’intégration de ces services, il constitue la base technique pour les clients souhaitant s’interfacer avec Amana. 3 Guide d’intégration Services Amana Liste des Services et API Amana 4 Guide d’intégration Services Amana SERVICE D’IMPORT EN MASSE (F.I.M SHIPMENT) Description du service F.I.M Le fichier d’import en masse comporte la liste des colis destinés à Amana selon un format donné qui devra être produit par le client et envoyer à Amana. Format du F.I.M Obligatoire/ Description Champs Facultative Id Prestation offerte par Amana (sera communiquée ultérieurement) O Cas Offre Point Relais : Code 32 pour l’INTRAVILLE et 31 pour Id_produit L’INTERVILLE Code Barre O Code envoi selon la structure détaillée dans le « service labelling » Code Ville O Se référer à la liste des codes villes (annexe 1). Poids O Poids : >0 et <= 31 KG RS/ Nom O Nom ou raison sociale du destinataire Prénom O Prénom du destinataire Pays O Pays Code Postal O Code postal Ville O Ville Quartier O Quartier Rue O Rue O SI Spécifier le code du point relais en se référant à la liste des Points LIVRAISON Relais remonté par l’API (Pickup) POINT RELAIS F SI LIVRAISON DOMICILE OU AGENCE Code point relais F Les N° de Gsm des destinataires : doivent respecter les 10 chiffres Tel destinataire d’un n° mobile Tel expéditeur F Le N° de Gsm de l’expéditeur : doit respecter les 10 chiffres d’un n° 5 Guide d’intégration Services Amana mobile Valeur déclarée F 0<=VD< 50 000 POD (Proof of Delivery) F 0 POUR NON 1 POUR OUI Service Crbt (espèce) F 0<=CRBT< 50 000(gardez NULL si pas le client n’a pas opté pour le service CRBT espèce) (Service contre remboursement espèce) Service Crbt (chèque) F 0<=CRBT< 50 000(gardez NULL si pas le client n’a pas opté pour le service CRBT chèque) (Service contre remboursement chèque) O 0 pour « Non » Fragile 1 pour « Oui » Longueur F En cm Largeur F En cm Hauteur F En cm Code Fournisseur F Code du fournisseur le cas échéant BL F Champ réservé Protocole d’Echange Le fichier d’import en masse devra être produit par le client et envoyé à Amana selon les protocoles d’échanges suivants : Messagerie électronique : Envoi par mail au contact désigné par Amana lors de la contractualisation Echange SFTP : Le client met à disposition de Amana sur son serveur FTP le fichier F.I.M Echange PeSit : Le client disposant d’une solution intégrant le protocole PeSit pourra communiqué avec Amana selon ce protocole 6 Guide d’intégration Services Amana CODES A BARRES (LABELLING) Description du Service Labelling Le client génère le code à barre à partir de son système d’information selon des règles définis par Amana Règles de génération du Labelling Le code à barre généré par le client devra respecter les règles suivantes : - Nombre de Caractères : 50 Max - Préfixe : Le code à barre généré devra être préfixé par deux caractères communiqués au client avant le démarrage de la phase intégration - Suffixe : MA (fixe) Exemple EX566292975MA 5A 5B 5C - 5A : Préfixe client (2 caractères) - 5B : identifiant pays MAROC fixe (2 caractères) - 5C : plage de 50 caractères (Max) à gérer par le client soit via l’algorithme AMANA (Annexe3) ou son propre algorithme, l’idéal est d’y mettre le N° de commande client 7 Guide d’intégration Services Amana API POINT RELAIS (PICKUP) Description du service Pickup Le service Pickup un Webservice mis à la disposition des sites marchands pour permettre à leurs clients d’afficher une liste de Points Relais disponibles pour le retrait de leur commande. Il prend en compte un certain nombre de paramètres afin d’afficher l’information la plus pertinente possible en termes de service rendu au client. Ces paramètres dépendent du transporteur, du site marchand (délai de préparation, poids du colis, etc.), du réseau wsamanapr (adresse des points relais,