Transcription
C2 – Usage restreintContrat de service détailléCréation d’enveloppes en EDIVersion 0.6 du 17/05/2022État En attente de validationRéférence :CDS Enveloppe EDI impression.odtDescriptionContrat de service détaillé pour la création d’enveloppes en rexitEva MAGNONEContributeur(s)Adrien BONVINHistorique des modificationsVersion0.1Description des modificationsInitialisation du documentAuteur.e.sDate26/11/20210.2Réorganisation du sommaire ajout de la partie 3 :Caractéristiques communes à tous les échangesDGDDI21/12/20210.30.4Prise en compte des retours de relecture de SI1Évolutions de l’itération 3 du lot 5 :DGDDIDGDDI24/12/2117/03/22Précision sur les URL dans le cadre del’itération 3 du lot 5Prise en compte des retours de relecture desspécifications de l’itération 3 du lot 5DGDDI31/03/22Prise en compte des retours de la MOADGDDI17/05/22 0.5 0.6 Ajout de l’information du sens de latraversée à la création de l’enveloppeContrôle de la cohérence des déclarationscontenues dans l’enveloppeModification du format du jetonModification du paramétrage desdéclarations autorisées dans une enveloppeimport pour permettre l’appairage des ENSContrôle de la présence de déclarations endoublonSuppression du « 0 » et du « O » dans lejeton de l’enveloppe
C2 – Usage restreintCDS – EnveloppeVersion 0.5SommaireTable des matières1. INTRODUCTION.3OBJECTIF DU DOCUMENT.3TERMINOLOGIE.3DOCUMENTS DE RÉFÉRENCE.42. PRÉSENTATION.5DESCRIPTION DU SI BREXIT.5DESCRIPTION DE L’ENVELOPPE LOGISTIQUE.5DESCRIPTION DES PROCESSUS.5SCHÉMA GÉNÉRAL DE L’INTERACTION ENTRE LE SI BREXIT ET LE SYSTÈME EDI.63. CARACTÉRISTIQUES COMMUNES À TOUS LES ÉCHANGES.7PRINCIPE ET CANAL D’ÉCHANGE.7FORMAT D’ÉCHANGE.7NIVEAU DE SERVICE.7CONDITIONS D’UTILISATION.8SÉCURITÉ.8GESTION DES ERREURS.8Liste des codes d’erreur technique.8Liste des codes d’erreur fonctionnelle.8RÈGLES DE GESTION DE CONTRÔLE TRANSVERSES.9MRN NON ACCEPTÉS.10GÉNÉRATION D’UN CODE BARRE.114. CRÉATION D’UNE ENVELOPPE.12DIAGRAMME DE FLUX.12CAS D’UTILISATION.13DESCRIPTION DES CHAMPS.13Message reçu par le système.13Message renvoyé par le système.13Pas d’erreur. 13Erreur. 135. MODIFICATION D’UNE ENVELOPPE.14DIAGRAMME DE FLUX.14CAS D’UTILISATION.15DESCRIPTION DES CHAMPS.15Message reçu par le système.15Message renvoyé par le système.15Pas d’erreur. 15Au moins une déclaration en erreur.15
C2 – Usage restreintCDS – EnveloppeVersion 0.51. INTRODUCTION1. Objectif du documentCe document décrit les échanges entre les opérateurs et l'API leur permettant de gérer des enveloppeslogistiques. Cette API a vocation à être utilisée dans le cas d'un nombre important d'enveloppes afin de faciliterles traitements de masse.Pour chaque service, il décrit : La séquence ; Le cas nominal et les cas d’erreur ; Les messages échangés.Les règles de contrôle ainsi que les codes d’erreur sont décrits dans la partie 3. CARACTÉRISTIQUESCOMMUNES À TOUS LES ÉCHANGES(cf Liste des codes d’erreur et Règles de gestion de contrôletransverses ).2. TerminologieTermeDéfinitionAppairageLien entre l’unité de transport (plaques avant et arrière de l’unité de transport)et son contenu (formalités douanières associées) . L’appairage permet de lierdes formalités douanières à une unité de transport ou de déclarer l’absence dedéclaration liée à la marchandise.L’appairage contient les informations suivantes : Référence des formalités douanières (import, exportou transit) liées àla marchandise ou absence de déclaration, Présence de marchandises soumises à un contrôle SIVEP.MRNMovement Reference Number. Référence unique de déclaration attribué par ladouane, à codification / structure européenne.WebserviceProgramme informatique permettant la communication et l'échange de données entre applications et systèmes hétérogènes dans des environnements distribués.RESTREST (representational state transfer) est un style d'architecture logicielle définissant un ensemble de contraintes à utiliser pour créer des services web.IdentifiantRéférence de formalité douanière (MRN ou autre).ÉchangesDéfinit les échanges de données entre 2 systèmes informatiques . Leséchanges entrants se font du système EDI vers le SI Brexit et les échangessortants se font du SI Brexit vers le système EDI.
C2 – Usage restreintCDS – EnveloppeVersion 0.53. Documents de référenceRéf. n [1]Titre / Nom cteur(s)Amélie BretDate31/03/2022VersionV1.0.0[2]DCS BREXIT PartnersInterfaces.docDGDDI BREXIT Règles sur les formats dedéclarations à l'appairageEva Magnone06/10/2021V1.2Eva Magnone31/03/2022V0.4[3]
C2 – Usage restreintCDS – EnveloppeVersion 0.52. PRÉSENTATION1. Description du SI BrexitSuite à la décision prise par les Britanniques de quitter l'Union Européenne, la sortie du Royaume-Uni du TDU(Territoire Douanier Unique) a impliqué le rétablissement de formalités douanières au niveau des points d'entréeet de sortie des flux de marchandises en provenance et à destination du Royaume-Uni. La mise en place de lafrontière intelligente et son application, le SI Brexit, répond au besoin pour la DGDDI de se conformer aux nou velles contraintes réglementaires induites par le Brexit, tout en conservant la compétitivité et l'attractivité desports français. Cette solution a en charge de : Offrir une interface aux acteurs tiers du transport (Eurotunnel, DFDS, P&O, Brittany Ferries, etc.) leurpermettant d’échanger avec la Douane Fluidifier et faciliter les échanges de marchandises en provenance et à destination du UK Automatiser la gestion des formalités douanières en frontière dans les applications douanières Assurer l’aiguillage des camions en fonction des contrôles effectués par les applications douanières :Delta-G, ECS, Delta-T et ICS / DeltaP Offrir des outils de gestion et de supervision des flux de marchandisesLa frontière intelligente concerne à la fois le tunnel sous la Manche et les ports suivants : Calais, Dunkerque,Saint-Malo, Roscoff, Dieppe, Le Havre, Cherbourg et Caen.2. Description de l’enveloppe logistiqueL’enveloppe logistique permet aux opérateurs économiques (déclarants, transporteurs ou même chauffeurs) deregrouper des formalités douanières et/ou enveloppes de formalités déjà existantes, non liées à une unité detransport, au sein d’un même objetElle est créée à l’import ou à l’export.À l’appairage, le scan ou la saisie du code barre de l’enveloppe permettra de récupérer l’ensemble des formalitésdouanières et enveloppes rattachées, le but étant de fluidifier le processus d’appairageau niveau des ports et dutunnel et de faciliter les démarches des transporteurs et des chauffeurs.3. Description des processusLes échanges faisant l’objet d’une description détaillée dans le présent contrat de service sont les suivants : Création d’enveloppe :MessageDemande de création d’enveloppeCREA ENV Demande conforme : enveloppe crééeMessage de retour OK Demande non conforme : enveloppe non créeMessage de retour KO
C2 – Usage restreintCDS – EnveloppeVersion 0.5 Modification d’enveloppe :MessageModification de création d’enveloppeMODIF ENV Demande conforme : enveloppe modifiéeMessage de retour OK Demande non conforme : enveloppe non modifiéeMessage de retour KO4. Schéma général de l’interaction entre le SI Brexit et le système EDIFigure 1: Schéma général de l'interaction entre le SI Brexitet le système opérateur
C2 – Usage restreintCDS – EnveloppeVersion 0.53. CARACTÉRISTIQUES COMMUNES À TOUS LES ÉCHANGES1. Principe et canal d’échangeLes échanges décrits dans ce document utilisent un protocole HTTPS et les données sont sérialisées en JSON. Ilsse font par des webservice en REST via le canal internet.La publication des messages pour le SI Brexit consiste à : s’authentifier (cf. Conditions d’utilisation) appeler les webservices exposés recevoir le retour de la bonne prise en compte du message (code HTTP 200) ou recevoir une erreur éventuelle (code HTTP 400).Le retour de la bonne prise en compte du message confirme que le message sera bien traité en synchrone par leSI Brexit. L’ordonnancement des identifiants dans les messages reçus par le système est conservé dans les messages de réponse.Les webservices à appeler sont exposés sur l’URL t-api/v1/apiedi.2. Format d’échangeLes messages échangés entre les opérateurs et le SI Brexit (et inversement) s’effectuent exclusivement via desappels de webservices HTTPS avec le verbe POST en JSON.Le format des messages est défini dans ce présent document et dans le fichier de contrat de service technique basé sur la spécification open API (format yaml) [1].Les flux JSON échangés devront utiliser uniquement l’encodage UTF-8.3. Niveau de serviceNiveau de servicePériode7j/7, 24h/24Disponibilité99% Toute opération de maintenance sera communiquée aumoins 3 jours avant sa date de réalisation afin de permettre aux opérateurs d’anticiper l’indisponibilité desservices.Délai de prévenance pour une indisponibilitéprogrammée du SI BrexitTemps de traitement pour un échangePertes de Données Maximale Autorisée (PDMA) à 10 secondes.Il est conseillé de ne pas regrouper plus de 200déclarations dans une même enveloppe. Au-delà de 200déclarations, le temps de réponse n’est plus garanti.Pas de perte de données autorisée (hors indisponibilitéprolongée côté opérateur EDI).
C2 – Usage restreintCDS – EnveloppeVersion 0.54. Conditions d’utilisationL’opérateur doit avoir un accès EDI à InterBrexit et être titulaire d’une convention d’accès signée avec la DGDDI l’autorisant à créer des enveloppes sur le service dédié.Afin d'identifier la société qui appelle le webservice, un en-tête doit être présent dans chaque requête HTTP. Ledétail de cet en-tête peut être trouvé dans la spécification technique [1].5. SécuritéLa sécurité des échanges des systèmes opérateurs EDI vers le système d’information de la Douane est portée parune authentification via un token valide avec un chiffrement de tous les échanges en HTTPs.Les principes d’authentification sont les suivants : Les endpoints des services du SI douanier exposés sur Internet sont sécurisés via l’utilisation d’un jetond’authentification dans le header HTTP, Le jeton d’authentification obtenu doit ensuite être utilisé pendant toute sa durée de vie pour ne pas saturer inutilement le serveur d’authentification. L’endpoint n’est donc à rappeler que lorsque le jeton estexpiré.Le chiffrement des échanges en HTTPs doit s’effectuer selon le protocole TLS 1.2 via l’utilisation de certificats(one-way). Le certificat serveur du SI douanier est utilisé pour établir la session TLS.Seuls les prestataires disposant d’autorisations EDI et certifiés par la DGDDI sont en mesure d’échanger des informations de manière électronique.6. Gestion des erreursa) Liste des codes d’erreur techniqueLa distinction des erreurs lors d’un échange s’effectue via le code HTTP retourné et éventuellement des informations supplémentaires dans le corps de la réponse.Les codes HTTP possibles sont les suivants :Code HTTPDescription200Succès du traitement du message au système opérateur EDI500Erreur technique de l’API401 ou 403Token d’authentification manquant ou erroné400Erreur fonctionnelle sur les données reçues du système opérateur EDIb) Liste des codes d’erreur fonctionnelleCoded’erreurMessage associéCas fonctionnelFONC01Aucun identifiant (enveloppeou déclaration) n’estrenseigné.Aucun identifiant de déclaration oud’enveloppe n’est renseigné.CréationModificationXX
C2 – Usage restreintCDS – on 0.5Le format du champ estincorrect.Type de document incorrectL’identifiant d’enveloppe saisicorrespond à une enveloppecontenant déjà une ouplusieurs enveloppes.Identifiant en doublonL’enveloppe a déjà étéappairée.Le jeton renseigné necorrespond à aucuneenveloppe connue.Le format de l’identifiant estincorrect (ex. : 17 caractères,contrôle de la clé du MRN KO )Le format est correct mais le type dedocument n’est pas accepté dansl’enveloppe (ex. : déclarationd’export britannique)L’enveloppe à inclure comprenddéjà au moins une enveloppe.Un des identifiants renseignés estprésent au moins 2 fois dans la liste.L’enveloppe à modifier a déjà étéappairée.Le jeton de l’enveloppe-fillerenseignée n’est pas connu.XXXXXXXXXXXFONC08L’enveloppe n’a pas ététrouvée.Le jeton de l’enveloppe à modifierest inconnu.XFONC09Le jeton de l’enveloppe estincorrect.Le jeton de l’enveloppe à modifierest incorrect.XFONC10Le sens de la traversée n’estpas renseigné.Cette formalité a déjà fait l’objet d’une traversée, elle nepeut être de nouveau appairée.Le sens de la traversée (import ouexport) n’a pas été renseigné.XL’identifiant de déclaration oud’enveloppe fille existe déjà en baseet est associé à une UT embarquée.XFONC11X7. Règles de gestion de contrôle transversesLes règles de gestion de contrôle ci-dessus s’appliquent à la fois à la création et à la modification d’uneenveloppe.RéférenceENV CTR RG01ENV CTR RG02ENV CTR RG03Description de la règle de gestion- Le format de l’identifiant doit être de la forme suivante :- Déclaration d’import : [0-9](10) ou- Déclarations d’export et de transit (format MRN) : cf [2] ou- Jeton d’enveloppe : E[0-9A-Z](6 7)Si le format de l’identifiant ne correspond à aucun des formats décrits ci-dessus,alors le code d’erreur FONC02 lui est associé dans le message de réponse.Si l’identifiant est un MRN, un contrôle est réalisé sur le type de la déclaration.Si le type correspond à l’un des types décrits dans le chapitre 8. MRN nonacceptés, alors le code d’erreur FONC03 lui est associé dans le message deréponse.Si l’identifiant correspond à un jeton d’enveloppe, alors le système vérifie qu’ilcorrespond à une enveloppe connue et ne contenant que des identifiants dedéclaration.Sinon :- Si l’enveloppe est inconnue du système, alors le code d’erreur FONC07lui est associé dans le message de réponse.
C2 – Usage restreintCDS – EnveloppeRéférenceENV CTR RG04Version 0.5Description de la règle de gestion- Si l’enveloppe contient au moins un identifiant d’enveloppe, alors le coded’erreur FONC04 lui est associé dans le message de réponse.Si un identifiant est renseigné à au moins deux reprises dans un même message,alors le code d’erreur FONC05 est associé à toutes les occurrences de l’identifiantdans le message de réponse.ENV CTR RG05Le système contrôle que l’identifiant renseigné (enveloppe ou déclaration)correspond au sens de traversée renseigné (les formats de déclaration acceptés ouprohibés sont décrits dans le document [R1]).Si un identifiant correspond à une formalité non valide pour le sens de traverséerenseigné, alors le code d’erreur FONC03 lui est associé dans le message deréponse.ENV CTR RG06Le système contrôle que l’identifiant renseigné n’est pas déjà associé à une unité detransport embarquée.Si l’identifiant est déjà associé à une unité de transport embarquée, alors le coded’erreur FONC11 lui est associé dans le message de réponse.8. MRN non acceptésLes types de MRN ne pouvant être appairés dans le SI Brexit et étant par conséquent refusés lors de la créationou la modification d’une enveloppe sont décrits dans le document [3].9. Génération d’un code barreLa génération d’un code-barres d’une enveloppehttps://www.npmjs.com/package/jsbarcode (CODE128).crééeenEDIestpossibleavecl’outil
C2 – Usage restreintCDS – EnveloppeVersion 0.54. CRÉATION D’UNE ENVELOPPECe service permet de regrouper plusieurs déclarations et/ou enveloppes dans une nouvelle enveloppe.Nom du servicecreerEnveloppe URL/enveloppeActeursAPI EnveloppeOpérateurMode d’échangePutGetPostDelete1. Diagramme de fluxFigure 1 : Diagramme de flux pour la création d’enveloppe
C2 – Usage restreintCDS – EnveloppeVersion 0.52. Cas ’opérateur dispose d’un jeton d’authentification valide.Cas nominalL’opérateur envoie une liste de déclarations et/ou d’enveloppes, le sens de latraversée ainsi que son jeton d’authentification.Le service renvoie le jeton de l’enveloppe créée avec la liste des identifiants(déclaration(s) et/ou enveloppe(s)).Cas d’erreur 1Au moins un identifiant est en erreur.Le système répond avec la liste des identifiants en erreur ainsi que le code d’erreur etle message associé à chacun ainsi que la liste des identifiants provenant du messagede création.Cas d’erreur 2Le sens de la traversée n’est pas renseigné.Le système renvoie le code d’erreur ainsi que le message associé.3. Description des champsa) Message reçu par le systèmeChampjeton authentificationOccurrence1DescriptionJeton d’authentification du système émetteur du message de créationsensidentifiant11,nSens de la traversée (import ou export)Identifiant(s) de déclaration ou d’enveloppeb) Message renvoyé par le systèmei.Pas d’erreurChampjeton enveloppeOccurrence1DescriptionJeton de l’enveloppe générée de la forme : EI[1-9A-N P-Z](6) pour une enveloppe destinée àl’import ; EE[1-9A-N P-Z](6) pour une enveloppe destinée àl’export.identifiant1,nListe des identifiants contenus dans le message de dentifiant de la déclaration ou de l’enveloppe en erreurcodemessage11Code d’erreurMessage correspondantidentifiant1,nListe des identifiants contenus dans le message de créationii.Erreur
C2 – Usage restreintCDS – EnveloppeVersion 0.55. MODIFICATION D’UNE ENVELOPPECe service permet de modifier une enveloppe.Nom du servicemodifierEnveloppe URL/enveloppe/{jetonEnveloppe}ActeursAPI EnveloppeOpérateurMode d’échangePutGetPostDelete1. Diagramme de fluxFigure 2 : Diagramme de flux pour la modification d ‘enveloppe
C2 – Usage restreintCDS – EnveloppeVersion 0.52. Cas as nominalL’opérateur dispose d’un jeton d’authentification valide et a créé une enveloppe.L’opérateur envoie son jeton d’authentification, le jeton de l’enveloppe à modifierainsi que la liste modifiée de déclarations.Le service renvoie un message de succès.Cas d’erreur 1Au moins un identifiant est en erreur.Le système répond avec la liste des identifiants en erreur ainsi que le code d’erreur etle message associé à chacun ainsi que la liste des identifiants provenant du messagede modification.Cas d’erreur 2L’enveloppe à modifier est dans un statut incompatible (jeton incorrect, inexistant enbase ou enveloppe déjà appairée).Le système répond avec le code d’erreur correspondant et le message associé ainsique la liste des identifiants provenant du message de modification.3. Description des champsa) Message reçu par le systèmeChampjeton onJeton d’authentification du système émetteur du message demodificationIdentifiant(s) de déclaration ou d’enveloppeb) Message renvoyé par le systèmei.Pas d’erreurChampjeton enveloppeOccurrence1DescriptionJeton de l’enveloppe modifiéeidentifiant1,nListe des identifiants contenus dans le message de modificationii.Au moins une déclaration en tifiant de la déclaration ou de l’enveloppe en erreurcodemessage11,nCode d’erreurMessage correspondantidentifiant1,nListe des identifiants contenus dans le message de modification
L'opérateur doit avoir un accès EDI à InterBrexit et être titulaire d'une convention d'accès signée avec la DGD- DI l'autorisant à créer des enveloppes sur le service dédié. Afin d'identifier la société qui appelle le webservice, un en-tête doit être présent dans chaque requête HTTP.
