Détails de l'interface de programmation d'application (API) 3M
Applications API 3M et conditions d'utilisation pour les clients
1. Intégration — Étapes requises pour 3M et le client
-
Démarrage : (pour les clients admissibles)
- Orientation
- Paysage des API
- Cas d'utilisation
- Analyse des difficultés
- Sélection des applications
- Approbation des conditions juridiques et de sécurité
-
Examen fonctionnel :
- Documentation sur les fonctionnalités de l'API
- Structure des demandes et réponses
- Exemple de cas d'utilisation
- FAQ
-
Accès aux tests :
- Fournir l'identifiant client et le jeton, ainsi que les URL pour les tests
- Assistance technique 3M ou examen de la qualité des données
-
Production :
- Lancement en direct de données ou d'applications
- Assistance technique 3M selon les besoins
- Surveillance de l'utilisation continue ou des problèmes par 3M
2. Sécurité
- OAuth 2.0 pour l'authentification de l'utilisateur final
- URL d'authentification fournie par 3M
- L'URL sera différente pour l'assurance qualité et la production et sera fournie par 3M lors de la phase d'implémentation appropriée
- Création par 3M de l'identifiant et du secret client et fournie à l'utilisateur de l'API
- Les informations d'identification du client seront différentes pour l'assurance qualité et la production et seront fournies par 3M lors de la phase d'implémentation appropriée
- Transmission du jeton en tant que jeton porteur dans l'en-tête d'autorisation de la demande
- Fourniture par 3M de l'ensemble des jetons et des configurations à utiliser
- L'URL d'authentification est susceptible d'être modifiée ; toute modification sera communiquée par 3M avant son entrée en vigueur
- L'identifiant et le secret client sont susceptibles d'être modifiés ; toute modification sera communiquée par 3M avant son entrée en vigueur
3. Spécifications de l'API
- La passerelle API sera construite en tant qu'API RESTful
- Les données des demandes/réponses seront transmises au format JSON entre le client et le serveur
- Structure des demandes/réponses à fournir par 3M pour les API spécifiques utilisées
- Attributs obligatoires/facultatifs à fournir par 3M
- Les scénarios de prise en charge des erreurs (4xx, 5xx) pour les API spécifiques utilisées seront fournis par 3M
- Toutes les exigences spécifiques à l'API provenant du client (système appelant) seront communiquées par 3M lors de l'implémentation
- L'URL de l'API est susceptible d'être modifiée ; toute modification sera communiquée par 3M avant son entrée en vigueur.
4. Support de 3M pour chaque API
- Support continu en production en cas de besoin
- Analyse des indicateurs de la passerelle API concernant la convivialité, la fréquence, etc.
- Réalisation d'une rétrospective avec le client afin d'obtenir un aperçu de la satisfaction globale, de l'utilisation, des problèmes et des demandes d'amélioration concernant l'API
