Detalles de la interfaz de programación de aplicaciones (API) de 3M
Aplicaciones de la API de 3M y condiciones de uso del cliente
1. Incorporación: pasos necesarios de 3M y el cliente
-
Puesta en marcha: (para clientes habilitados)
- Orientación
- Panorama general de la API
- Casos de uso
- Revisión de puntos problemáticos
- Selección de aplicaciones
- Aprobación legal y de seguridad de las Condiciones
-
Revisión funcional:
- Documentación de funcionalidades de la API
- Estructura de solicitudes y respuestas
- Ejemplos de casos de uso
- Preguntas frecuentes
-
Prueba de acceso:
- Proporcionar número de cliente y token de seguridad, URL para pruebas
- Soporte técnico de 3M o revisiones de calidad de datos
-
Producción:
- Lanzamiento en directo de datos o de la aplicación
- Soporte técnico de 3M según sea necesario
- 3M supervisará el uso continuo o los problemas
2. Seguridad
- OAuth 2.0 para la autenticación de usuarios finales
- URL de autenticación que debe proporcionar 3M
- La URL será diferente para QA y PROD y la proporcionará 3M en la fase de implementación apropiada
- El número de identificación de cliente y el numero secreto del cliente que debe crear 3M y proporcionar al usuario de la API
- Las credenciales del cliente serán diferentes para QA y PROD y las proporcionará 3M en la fase de implementación apropiada
- Token que se pasará como token de portador en el encabezado de autorización de la solicitud
- Toda la tokenización y configuraciones de uso las proporcionará 3M
- La URL de autenticación está sujeta a cambios; 3M comunicará cualquier cambio antes de que entre en vigor
- El número de identificación de cliente y el numero secreto del cliente están sujetos a cambios; 3M comunicará cualquier cambio antes de que entre en vigor
3. Especificaciones de API
- Entrada API creada como API RESTful
- Datos de solicitud/respuesta que se transmitirán como JSON entre el cliente y el servidor
- Estructura de solicitudes y respuestas para las API específicas utilizadas que debe proporcionar 3M
- Atributos obligatorios/opcionales que debe proporcionar 3M
- Escenarios de tratamiento de errores (4xx, 5xx) para las API específicas utilizadas que debe proporcionar 3M
- Todos los requisitos específicos de las API del cliente (sistema de llamada) los debe proporcionar 3M durante la implementación
- La URL de las API está sujeta a cambios; 3M proporcionará cualquier cambio antes de que entre en vigor
4. Soporte de 3M para cada API
- Proporcionar soporte continuo de PROD cuando sea necesario
- Analizar las métricas de entrada API sobre usabilidad, frecuencia, etc.
- Realizar una retrospectiva con el cliente para conocer la satisfacción general con la API, el uso, los problemas y las solicitudes de mejora
