3M Application Programming Interface (API) Details
3M API applications and Customer Terms of Use
1. Onboarding — 3M and Customer required steps
-
Kickoff: (for qualified customers)
- Orientação
- API Landscope
- Casos de utilização
- Revisão de pontos críticos
- Seleção de aplicações
- Aprovação das condições jurídicas e de segurança
-
Functional Review:
- Documentação da funcionalidade da API
- Estrutura de pedidos e respostas
- Exemplos de casos de utilização
- FAQs
-
Testing Access:
- Fornecer ID de cliente e Token de segurança, URLs para teste
- Suporte técnico da 3M ou revisões da qualidade dos dados
-
Production:
- Lançamento em direto de dados ou aplicações
- Apoio técnico da 3M, se necessário
- A 3M monitorizará a utilização contínua ou problemas
2. Security
- OAuth 2.0 para autenticação do utilizador final
- AuthenticationURL a ser fornecido pela 3M
- O URL será diferente para GQ e PROD e será fornecido pela 3M na fase de implementação adequada
- ID e segredo do cliente a serem criados pela 3M e fornecidos ao consumidor da API
- As credenciais do cliente serão diferentes para os ambientes de QA e PROD e serão fornecidas pela 3M na fase de implementação adequada
- Token a ser passado como token de portador no cabeçalho de autorização do pedido
- Todas as definições e tokenização para utilização serão fornecidas pela 3M
- URL de autenticação sujeito a alterações; quaisquer alterações serão fornecidas pela 3M antes de entrarem em vigor
- ID e segredo do cliente sujeitos a alterações; quaisquer alterações serão fornecidas pela 3M antes de entrarem em vigor
3. API Specifications
- Gateway de API construído como API RESTful
- Dados de pedido/resposta a serem transmitidos como JSON entre o cliente e o servidor
- Estrutura de pedido/resposta para APIs específicas que estão a ser consumidas, a ser fornecida pela 3M
- Atributos obrigatórios/opcionais a fornecer pela 3M
- Os cenários de tratamento de erros (4xx, 5xx) para APIs específicas que estão a ser consumidas devem ser fornecidos pela 3M
- Todos os requisitos específicos da API do cliente (sistema de chamada) devem ser fornecidos pela 3M durante a implementação
- O URL da API está sujeito a alterações; quaisquer alterações serão fornecidas pela 3M antes de entrarem em vigor
4. 3M support for each API
- Prestar suporte contínuo ao PROD quando necessário
- Analisar as métricas do API Gateway relativamente à usabilidade, frequência, etc.
- Conduzir uma retrospetiva com o cliente para obter informações sobre a satisfação geral com a API, a utilização, os problemas e os pedidos de melhoria
