Aller au contenu

Spécification d'intégration API

Décrivez la connexion entre deux systèmes : données échangées, sécurité, gestion des erreurs et responsabilités.

Remplir et prévisualiser

Spécification d'intégration API

Intégration : Commandes de la boutique vers la comptabilité
Version : 1.0
Rédigé par : Hamza Idrissi
Date : 5 avril 2029

1. Objectif

Envoyer chaque commande payée de la boutique en ligne au système comptable sous forme de facture de vente, afin que le service financier ne la saisisse pas à nouveau.

2. Systèmes

  • Envoie les données : Boutique en ligne (API v2)
  • Reçoit les données : Système comptable (API REST)

3. Flux de données

1. Un client paie une commande.
2. La boutique envoie un webhook au service d'intégration.
3. Le service transforme la commande en facture et appelle l'API comptable.
4. Le système comptable renvoie un numéro de facture, que le service enregistre sur la commande.

4. Points de terminaison et messages

Méthode et chemin Ce qu'il fait Champs principaux Ce qu'il renvoie
POST /invoices Créer une facture Corps : client, lignes, taxe, total Renvoie : identifiant et numéro de facture
GET /customers?email= Rechercher un client Renvoie : identifiant du client ou vide
POST /customers Créer un client Corps : nom, e-mail, adresse

5. Correspondance des champs

order.total_paid → invoice.total
order.billing_email → customer.email
order.items[].sku → line.product_code

6. Authentification et sécurité

OAuth 2.0 avec identifiants client. Les jetons durent une heure. Les secrets sont conservés dans le coffre-fort, jamais dans le code. Tous les appels utilisent HTTPS. Les webhooks sont signés et la signature est vérifiée.

Les données personnelles ne sont envoyées que lorsque cela est nécessaire, ne sont pas écrites dans les journaux et sont couvertes par les conditions de confidentialité des deux systèmes.

7. Erreurs et nouvelles tentatives

Réessayez sur les erreurs 429 et 5xx jusqu'à 5 fois avec des délais croissants. Ne réessayez pas les erreurs 4xx ; journalisez-les et alertez le service financier. Chaque facture possède une clé unique afin qu'une nouvelle tentative ne crée pas de doublon.

8. Limites et volumes

L'API comptable autorise 60 appels par minute. Prévision de 400 commandes par jour, jusqu'à 2 000 les jours de soldes.

9. Tests

Utilisez l'environnement de test comptable. Testez une commande normale, une commande avec remise, un remboursement, un client déjà existant et une panne de l'API.

10. Responsables et support

Responsable : équipe e-commerce. Support : Hamza Idrissi. Escalade : le support du fournisseur comptable.

11. Modifications et gestion des versions

Chaque partie prévient 30 jours à l'avance en cas de changement incompatible.

Les modèles sont un point de départ soigné, pas un conseil juridique. Lorsque l'aspect juridique est important, vérifiez ce qui s'applique là où vous vous trouvez.

Informatique et projets

À quoi sert ce modèle

Spécification d'intégration API : objectif, flux de données, points de terminaison, authentification, erreurs, limites, tests et responsables.

Le remplissage en ligne est gratuit, ne nécessite aucun compte et le document se télécharge au format Word ou PDF. Voir tous les modèles de Informatique et projets

Informatique et projets

Ce que vous remplissez

Le formulaire demande 16 informations. Le document se remplit au fur et à mesure que vous tapez.

  • Nom de l'intégration

    Par exemple : Commandes de la boutique vers la comptabilité

  • Version du document

    Par exemple : 1.0

  • Rédigé par

    Par exemple : Hamza Idrissi

  • Date

    Par exemple : 5 avril 2029

  • Objectif

    Par exemple : Envoyer chaque commande payée de la boutique en ligne au système comptable sous forme de facture de vente, afin que le service financier ne la saisisse pas à nouveau.

  • Système qui envoie les données

    Par exemple : Boutique en ligne (API v2)

  • Système qui reçoit les données

    Par exemple : Système comptable (API REST)

  • Flux de données

    Par exemple : 1. Un client paie une commande. 2. La boutique envoie un webhook au service d'intégration. 3. Le service transforme la commande en facture et appelle l'API comptable. 4. Le système comptable renvoie un numéro de facture, que le service enregistre sur la commande.

  • Points de terminaison et messages

    Une ligne par point d'accès ou message.

    Par exemple : POST /invoices | Créer une facture | Corps : client, lignes, taxe, total | Renvoie : identifiant et numéro de facture GET /customers?email= | Rechercher un client | Renvoie : identifiant du client ou vide POST /customers | Créer un client | Corps : nom, e-mail, adresse

  • Correspondance des champs

    Quel champ de la source correspond à quel champ de la cible. Indiquez comment les valeurs sont converties.

    Par exemple : order.total_paid → invoice.total order.billing_email → customer.email order.items[].sku → line.product_code

  • Authentification et sécurité

    Par exemple : OAuth 2.0 avec identifiants client. Les jetons durent une heure. Les secrets sont conservés dans le coffre-fort, jamais dans le code. Tous les appels utilisent HTTPS. Les webhooks sont signés et la signature est vérifiée.

  • Erreurs et nouvelles tentatives

    Par exemple : Réessayez sur les erreurs 429 et 5xx jusqu'à 5 fois avec des délais croissants. Ne réessayez pas les erreurs 4xx ; journalisez-les et alertez le service financier. Chaque facture possède une clé unique afin qu'une nouvelle tentative ne crée pas de doublon.

  • Limites et volumes (facultatif)facultatif

    Par exemple : L'API comptable autorise 60 appels par minute. Prévision de 400 commandes par jour, jusqu'à 2 000 les jours de soldes.

  • Tests

    Par exemple : Utilisez l'environnement de test comptable. Testez une commande normale, une commande avec remise, un remboursement, un client déjà existant et une panne de l'API.

  • Responsables et support

    Par exemple : Responsable : équipe e-commerce. Support : Hamza Idrissi. Escalade : le support du fournisseur comptable.

  • Modifications et gestion des versions (facultatif)facultatif

    Par exemple : Chaque partie prévient 30 jours à l'avance en cas de changement incompatible.

Informatique et projets

Contenu du document

Les parties de ce document, dans l'ordre.

  1. 11. Objectif
  2. 22. Systèmes
  3. 33. Flux de données
  4. 44. Points de terminaison et messages
  5. 55. Correspondance des champs
  6. 66. Authentification et sécurité
  7. 77. Erreurs et nouvelles tentatives
  8. 88. Limites et volumes
  9. 99. Tests
  10. 1010. Responsables et support
  11. 1111. Modifications et gestion des versions

Modèles

Comment ça marche

  1. 01

    Remplir

    Saisissez vos informations dans le formulaire. Le document se remplit au fur et à mesure ; cliquez sur un espace à remplir pour accéder à son champ.

  2. 02

    Vérifier

    Relisez-le. Les espaces non remplis restent signalés, pour qu'aucun document ne soit envoyé à moitié terminé.

  3. 03

    Télécharger

    Enregistrez-le en document Word pour le modifier, ou en PDF pour l'envoyer ou l'imprimer.

Personnalisez-le avec l'IA

Ouvrez-le dans le chat et demandez des modifications : plus court, plus ferme, une autre situation, une autre langue.

L'adapter avec nerix

Informatique et projets

Questions fréquentes

Quelles informations ce modèle demande-t-il ?

Le formulaire demande 16 informations, à commencer par Nom de l'intégration, Version du document, Rédigé par, Date, Objectif. 2 autres sont facultatives.

Puis-je télécharger ce modèle au format Word ou PDF ?

Oui. Une fois le formulaire rempli, enregistrez-le au format Word pour continuer à le modifier, ou au format PDF pour l’envoyer ou l’imprimer. C’est gratuit et aucun compte n’est nécessaire.

Ce que je saisis est-il envoyé quelque part ?

Non. Ce que vous saisissez reste dans votre navigateur pendant que vous remplissez le document. Cela n’est transmis à nerix que si vous choisissez d’ouvrir le modèle dans le chat.

Ces modèles informatique et projets sont-ils gratuits ?

La plupart. Remplissez-les et téléchargez-les gratuitement en Word ou en PDF, sans compte. Quelques documents plus longs sont premium : gratuits à remplir, payés une fois pour le téléchargement, et marqués de leur prix.

Une politique de sécurité nous protège-t-elle ?

Aucun document n'y suffit seul. Une politique aide quand elle correspond à ce que les gens font vraiment : gardez-la courte, expliquez-la à votre équipe et revoyez-la chaque année.

Une charte de projet est-elle réservée aux grands projets ?

Non. Un petit projet en profite aussi, car une page qui nomme l'objectif, les limites et le décideur évite la plupart des disputes plus tard.