Détails de l’interface de programmation d’applications (API) de 3M
Applications de l’API 3M et conditions d’utilisation pour les clients
1. Intégration – Étapes nécessaires pour 3M et le client
-
Lancement initial : (dédié aux clients qualifiés)
- Orientation
- Délimitation des fonctionnalités de l’API
- Cas d’utilisation
- Examen des difficultés
- Choix des applications
- Validation des conditions par les services juridiques et de sécurité
-
Analyse fonctionnelle :
- Rédaction de la documentation des fonctionnalités de l’API
- Définition de la structure des requêtes et des réponses
- Présentation d’exemples de cas pratiques
- FAQ
-
Accès aux tests :
- Transmission du numéro d’identification du client, du jeton de sécurité et des adresses URL dédiées aux tests
- Soutien technique 3M ou vérification de la qualité des données
-
Mise en production :
- Activation en direct des données ou de l’application
- Soutien technique 3M si nécessaire
- 3M assurera le suivi de l’usage continu ou des éventuels problèmes
2. Sécurité
- OAuth 2.0 pour l’authentification de l’utilisateur final
- Adresse URL d’authentification à fournir par 3M
- L’adresse URL sera spécifique pour les services de contrôle qualité et de production, et sera communiquée par 3M lors de la phase de mise en œuvre correspondante
- Numéro d’identification et secret du client à créer par 3M et transmis à l’utilisateur de l’API
- Les informations d’identification du client seront distinctes pour le contrôle de qualité et la production, et seront fournies par 3M durant la phase de mise en œuvre appropriée
- Jeton à inclure comme jeton de support dans l’en-tête d’autorisation de la requête
- Toutes les configurations relatives à la génération de jetons et à son usage seront fournies par 3M
- L’adresse URL d’authentification est susceptible de modifications; toute modification sera communiquée par 3M avant son entrée en vigueur
- Le numéro d’identification et le secret du client sont susceptibles de modifications; toute modification sera transmise par 3M avant son entrée en vigueur
3. Spécifications de l’API
- Une passerelle API conçue selon les principes RESTful
- Les données des requêtes et des réponses sont échangées sous le format JSON entre le client et le serveur
- La définition des structures des requêtes et des réponses pour les API spécifiques consommées devra être fournie par 3M
- Les attributs obligatoires et facultatifs devront être précisés par 3M
- Les scénarios de gestion des erreurs (4xx, 5xx) pour les API spécifiques consommées devront être définis par 3M
- Toute exigence particulière relative à l’API de la part du client (système appelant) devra être fournie par 3M au cours de la mise en œuvre
- L’adresse URL de l’API pourrait être sujette à modification; toute mise à jour sera communiquée par 3M avant sa prise d’effet
4. Soutien 3M pour chaque API
- Assurer un soutien continu en production si nécessaire
- Examiner les paramètres de la passerelle API en termes de convivialité, de fréquence d’utilisation, etc.
- Réaliser un bilan avec le client pour recueillir un retour global sur la satisfaction concernant l’API, son utilisation, les problèmes rencontrés, ainsi que les demandes d’amélioration
