Processo de Certificação
Por que Certificação?
Como mencionado na Por que Desenvolver APIs? seção, o principal objetivo das APIs DCP é apoiar as operações comerciais e o crescimento dos revendedores da BRP.
Nesse contexto, é importante que a implementação da API DCP siga a interface e os comportamentos definidos e que a integração no DSP apoie os objetivos comerciais.
A validação é feita através de um processo de certificação que valida cada integração de API.
Visão Geral da Certificação
As atividades de certificação são escaladas de acordo com a complexidade e criticidade da API DCP. Existem três categorias de APIs DCP:
- As APIs usadas pelo DSP para recuperar dados, como o catálogo de peças,
- As APIs usadas pelo DSP para enviar dados para o BRP, por exemplo, o inventário de peças do revendedor.
- As APIs são usadas para transações, como a encomenda de peças.
Em cada categoria, a complexidade da API DCP pode ser:
- Baixa: pequena quantidade de dados e chamadas de API simples, como especificação de unidade.
- Média: Os dados são mais críticos, ou há muitas chamadas diferentes, como localizador de peças.
- Alta: Os dados são mais complexos/críticos, e/ou há muitas chamadas de API diferentes, como os dados de transações de varejo.
As atividades de certificação para cada API DCP são descritas em detalhes na Catálogo de API seção.
Uma vez que todas as atividades de certificação estejam concluídas, o último passo de certificação é a fase piloto do revendedor.
Fases de Certificação
Fase 1: Desenvolvimento
Nesta fase, você começa o desenvolvimento com base na documentação da API DCP fornecida neste portal.
Após ler a documentação da API, uma reunião de início pode ser organizada se você tiver perguntas.
Durante esta fase, você pode usar simulações para validar a integração básica da API DCP e, quando estiver mais avançado na integração, usar o ambiente de teste para fazer chamadas à API.
❗❗ Ao começar a trabalhar em uma API DCP, precisamos solicitar acesso criando um ticket de certificação, conforme descrito na Atividades de Certificação com JIRA seção encontrada abaixo.
Fase 2: Garantia de Qualidade
Durante esta fase, atividades de teste, verificação e validação são realizadas para confirmar que a API DCP está devidamente integrada ao DSP. Os requisitos do DSP especificados para a API DCP também foram verificados para atender aos requisitos de negócios. Veja a seção Catálogo de API para uma introdução aos requisitos do DSP.
Um conjunto diferente de atividades de certificação é definido para cada categoria de API e combinação de complexidade. As atividades de certificação são:
- Uma demonstração da função no DSP.
- Validação dos dados recebidos pelo BRP.
- Casos de teste formais.
Salvo especificação em contrário, essas atividades são realizadas usando o ambiente de teste da API DCP e o ambiente de teste do DSP.
Ao realizar os testes, todas as funções da API e do DSP, incluindo os trabalhos do DSP que chamam automaticamente a API, devem estar disponíveis e verificadas.
Por exemplo, o API de Peças deve ser chamado diariamente para recuperar as alterações do catálogo de peças. O trabalho que chama a API de Peças deve estar habilitado durante os testes da fase 2.
Fase 3: Piloto de Concessionária
Usando alguns concessionários, a fase piloto de concessionária valida a integração e a funcionalidade do DSP no ambiente de produção.
A fase piloto do revendedor tem como objetivo confirmar que a integração da API DCP está funcionando conforme o esperado no ambiente de produção real e com revendedores usando o DSP para suas operações normais.
Durante a fase piloto do revendedor, as principais atividades são demonstrar a funcionalidade do DSP e validar os dados recebidos pela BRP.
👉 A demonstração pode ser feita enviando capturas de tela ou arquivos ou realizando uma sessão ao vivo para demonstrar a funcionalidade do seu DSP.
As condições do piloto do revendedor variam dependendo do escopo da API DCP, mas normalmente é conduzido com 1 a 5 revendedores por 1 a 3 semanas.
Ao realizar a fase piloto do revendedor, todas as funções da API e do DSP, incluindo os trabalhos do DSP que chamam automaticamente a API, devem estar disponíveis e verificadas.
Por exemplo, a API de Peças deve ser chamada diariamente para recuperar as alterações no catálogo de peças. O trabalho que chama a API de Peças deve estar habilitado durante a fase piloto do revendedor.
Status da Certificação da API DCP
A equipe DCP acompanha o status de certificação do DSP de cada API, que é disponibilizado aos revendedores através do Centro de Conhecimento BOSSWeb.
Um DSP não pode oferecer uma funcionalidade da API DCP aos revendedores até que o processo de certificação seja concluído.
Atividades de Certificação com Jira
Para ajudar no planejamento e acompanhamento das atividades de certificação, a DCP implementou um sistema de tickets usando o Jira.
Você terá acesso ao Jira da DCP quando estiver pronto para começar o desenvolvimento da primeira API. Uma reunião de início é organizada com sua equipe de desenvolvimento para apresentar o portal de documentação da DCP e o sistema de tickets do DSCP Jira.
👉 O Jira da DCP também é usado para fazer perguntas, solicitar suporte e adicionar/remover membros da equipe. Consulte a seção Obtendo Suporte para mais informações.
Esta seção descreve como usar os tickets de certificação para gerenciar suas atividades de certificação.
❗❗ É importante criar o ticket Jira para uma certificação de API apenas quando você começar a trabalhar na API ❗❗
Em outras palavras, não use os tickets Jira do DCP para criar um backlog!
Fluxo de Trabalho
O fluxo de trabalho do ticket de certificação é apresentado na imagem abaixo.
Quando você estiver pronto para começar a trabalhar em uma API, vá para o portal Jira do DCP e abra um ticket para a API.
❗❗ Crie o ticket Jira apenas quando você começar a trabalhar na API ❗❗
A equipe do DCP habilita suas credenciais na API no ambiente de QA e muda o estado do ticket para Em Desenvolvimento.
Quando você estiver pronto para iniciar a fase de garantia de qualidade (teste), mude o estado do ticket para Em Teste. Se você tiver evidências de teste para fornecer, como capturas de tela, anexe os arquivos ao ticket.
Quando a equipe do DCP valida os resultados do teste, o estado do ticket é alterado para Em Preparação para o Piloto do Dealer. Durante esta fase, você prepara o piloto do dealer com os dealers, e a equipe do DCP habilita suas credenciais na API no ambiente de produção.
Quando o piloto do dealer começa, você muda o estado do ticket para No Piloto do Dealer. Se você tiver evidências de teste para fornecer, como capturas de tela, anexe os arquivos ao ticket.
Uma vez que a equipe do DCP valida os resultados do piloto do dealer, eles mudam o estado do ticket para Certificado para indicar que a API está certificada.
👉 Toda vez que você muda o estado do ticket ou insere um comentário, a equipe do DCP recebe uma notificação.
Funciona também ao contrário: toda vez que a equipe do DCP muda o estado do ticket ou insere um comentário, sua equipe recebe uma notificação.
O Portal Jira
Como Acessar
Depois de assinar o contrato DCP, um membro da equipe DCP criará um grupo para sua empresa no Jira, e você e seus membros da equipe receberão um convite por e-mail.
O e-mail contém um link para se inscrever no sistema de tickets do Jira. Assim que você clicar no link, será levado à plataforma Jira para criar sua conta.
✏ 👉 Não desative a notificação por e-mail! Se você fizer isso, não será notificado quando o ticket for atualizado.
Menu Principal
Quando você acessar o portal DCP Jira, a seguinte tela aparecerá assim que você fizer login.
❗❗ Antes de criar um ticket, verifique se você está no portal DCP Jira ❗❗
Verifique a seção Certifique-se de que você está no portal DCP! abaixo.
Clique no menu de Integração de API.
Integração de API
A página de Certificação e Suporte DCP é exibida.
- Selecione A Integração de API na lista Entre em contato conosco sobre.
- Clique em Certificação de Integração de API.
- O formulário de ticket de Certificação de Integração de API é exibido.
Formulário de Ticket de Certificação de Integração de API
Um formulário é exibido onde você deve inserir os detalhes do pedido.
Para ajudar a gerenciar o ticket, o campo de título deve ser assim:
Certificação de API - [nome da sua organização] - [nome da API]
Por exemplo:
Certificação de API - MyDMS - Informações do DSP
Em seguida, selecione a API na Qual API você deseja obter certificação? lista.
Finalmente, forneça estimativas aproximadas para as datas de início e término para nos ajudar a acompanhar sua linha do tempo de certificação e melhor apoiá-lo.
Clique Enviar para enviar seu ticket.
Como Alterar o Estado de um Ticket de Certificação
Conforme mencionado na Fluxo de Trabalho seção, você deve alterar o estado de um ticket de certificação em 2 etapas do fluxo de trabalho:
- Quando você estiver pronto para iniciar a fase de garantia de qualidade (teste), altere o estado do ticket para Em Teste. Se você tiver evidências de teste para fornecer, como capturas de tela, anexe os arquivos ao ticket.
- Quando o piloto do revendedor começar, você altera o estado do ticket para Em Piloto do Revendedor. Se você tiver evidências de teste para fornecer, como capturas de tela, anexe os arquivos ao ticket.
Para alterar o estado do ticket, abra-o e olhe no lado direito do formulário, destacado em verde na imagem abaixo.
Neste exemplo, clique em Mover para o Dealer Pilot, e uma janela será aberta. Você pode inserir um comentário e clicar em Mover para o Dealer Pilot.
A equipe DCP recebe uma notificação da mudança de estado.
Certifique-se de que você está no Portal DCP!
O DCP Jira está usando o Jira Service Management (JSM).
🛑 Você tem acesso a todos os projetos JSM na BRP!
Então, antes de criar um ticket, certifique-se de que você está no Portal de Certificação e Suporte DCP.
Quando você estiver no portal DCP Jira, clique no Centro de Ajuda link no canto superior esquerdo. Você será enviado para a página principal do BRP JSM, onde você pode ver todos os portais!
Será ignorado se você criar um ticket em um portal diferente do Portal de Certificação e Suporte DCP!
!
Se você estiver na Help Center página principal, a maneira mais segura de encontrar o DCP Certification and Support portal é usar o campo de busca e procurar por DCP.
Uma lista de recursos de ajuda é exibida.
Você pode abrir um dos formulários DCP a partir do resultado da busca ou ir para o DCP Certification and Support portal.
Roteiro de Desenvolvimento
A menos que você e o DCP tenham concordado com um roteiro diferente, as APIs devem ser desenvolvidas e certificadas na ordem apresentada abaixo.
DMS
Prioridade | Nome da API |
|---|---|
1 | |
2 | API de Peças |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | |
10 | |
11 | |
12 | |
13 | |
14 | |
15 | |
16 | |
17 |
CRM
Prioridade | Nome da API |
|---|---|
1 | |
2 | |
3 | API de Promoções (opcional) |
4 | API de Unidades (opcional) |
5 | API de Peças (opcional) |