Roteiro de homologação débito veicular

Objetivo

O roteiro de homologação tem como objetivo avaliar se o sistema integrado a Celcoin está apto a utilizar as APIs de Débito Veicular.

Débito Veicular

A API de débito veicular permite a criação de aplicações que possibilitam a pesquisa e liquidação de débitos de veículos, tais como multas, IPVA, licenciamento e seguro obrigatório.

Como funciona a homologação

Para ser homologado com a Celcoin é necessário realizar os testes diretamente na sua aplicação, onde seu usuário irá interagir. Ou seja, não serão aceitos testes realizados pelo postman, swagger, ou de qualquer outra plataforma que permita simulação de requisições e retornos. Os dados devem ser colocados em um documento e enviados para o suporte no formato .pdf ou .doc.

Como enviar os testes

Os testes deverão ser enviados via formulário pelo link. Para que o time de suporte possa analisar o roteiro, há duas formas de enviar esses dados: imagens + logs + dados cadastrais ou vídeo + logs + dados cadastrais.

Dados cadastrais que deverão ser enviados:

Para que o time de suporte possa analisar os testes, favor enviar (através do formulário http://celco.in/suporteapi), as imagens + logs ou vídeos + logs, juntamente com os dados cadastrais listados abaixo:

1. CNPJ;
2. Razão Social;
3. Endereço (Rua, número, bairro, município, UF e CEP);
4. Site;
5. Inscrição municipal e estadual;
6. E-mail e nome do responsável que receberá as credenciais de produção (login, senha e instruções);

Para criação dos usuários do nosso Portal, onde é possível acessar extratos das transações e acompanhar o saldo da Conta Celcoin, precisaremos de:

1. Nome Completo;
2. CPF;
3. E-mail;
4. Data de nascimento;
5. Especificar o perfil de acesso:
   1. Operacional: acesso aos extratos e acompanhamento de saldo;
   2. Financeiro: acesso aos extratos, acompanhamento de saldo e recebimento diário via e-mail de alertas de saldo e notas de débito.

Imagens + logs

É necessário o envio da imagem (print) + logs gerados pela sua aplicação ao executar os cenários. Conforme exemplo abaixo:

Vídeo + logs

Nesse caso você pode gravar a tela da sua aplicação mostrando a execução de cada cenário do roteiro. Os logs também são necessários e devem ser enviados com o mesmo padrão do exemplo acima. O documento de homologação deve conter o link de acesso aos vídeos e os logs das requisições.

🚧

Qualidade mínima do vídeo 720p e é necessário permitir acesso ao drive para o domínio Celcoin.

Roteiro homologação

É obrigatório a implementação de todos os cenários abaixo:

Webhooks

• Registrar URL para receber webhooks (vehicledebtsapi/v1/webhook/register)
• Consultar URL cadastrada (vehicledebtsapi/v1/webhook/search)

Webhook com autenticação via token - JWT

Caso tenha necessidade que a Celcoin se autentique em seu ambiente, é necessário realizar o cadastro do webhook via token.

• Registrar URL para receber webhooks com autenticação (https://sandbox.openfinance.celcoin.dev/vehicledebtsapi/v1/webhook/registerWithToken)

Consultar débitos de um veículo

• Consultar veículo com débitos (vehicledebtsapi/v1/debts)

  JSON

  {  
    "state": "DF",  
    "licensePlate": "DHA1346",  
    "renavam": "97752505834",
    "cpfCnpj": "11111111111",
    "clientRequestId": "veiculoComDebito"
  }
  

• Consultar veículo sem débitos (vehicledebtsapi/v1/debts)

  JSON

  {  
    "state": "DF",  
    "licensePlate": "VWD0001",  
    "renavam": "44336209403",
    "cpfCnpj": "11111111111",
    "clientRequestId": "veiculoSemDebito"
  
  }
  

• Consultar veículo inexistente (vehicledebtsapi/v1/debts)

  "state": "RS",  
  "licensePlate": "AAA0001",  
  "renavam": "01100026670", 
  "cpfCnpj": "11111111111",
  "clientRequestId": "veiculoNaoEncontrado"
 
}

• Consultar um veículo com débito dependente

{  
  "state": "SP",  
  "licensePlate": "DEP0004",  
  "renavam": "55286200365",
  "cpfCnpj": "11111111111",
  "clientRequestId": "debitoDependente"

}

• Consultar um veículo com débito distinto

{  
  "state": "MG",  
  "licensePlate": "DIS0001",  
  "renavam": "49628357217",
  "cpfCnpj": "11111111111",
  "clientRequestId": "debitoDistinto"

}

Realizar pagamentos de Débitos Veiculares

• Criar pagamento para o débito consultado (vehicledebtsapi/v1/payDebts)

{
     "debtIdList": [
          "4C15551C-B76B-42E2-85D2-AE8DAF906CA0"
     ],
     "transactionId": 816531486,
     "clientRequestId": "123459"

]
}

• Criar um pagamento com débito dependente - Erro (vehicledebtsapi/v1/payDebts)

{
     "debtIdList": [
       "316838F9-7207-446A-986A-6CCA41B98A14"
     ],
     "transactionId": 817669856,
     "clientRequestId": "1234560"

]
}

🚧

Note que você receberá um erro, pois existe dependência dos débitos, ou seja, você deve pagar todos os débitos que possuem dependência em conjunto.

• Criar um pagamento com débito dependente - Sucesso (vehicledebtsapi/v1/payDebts)

{
     "debtIdList": [
       "316838F9-7207-446A-986A-6CCA41B98A14",
       "1503B0BA-1C99-45C3-B656-3FF7BD0BF012",
       "0733466E-5E0F-4A25-95E9-755D836F35DF"
     ],
     "transactionId": 817669856,
     "clientRequestId": "12345610"

]
}

• Criar um pagamento com débito distinto - Erro(vehicledebtsapi/v1/payDebts)

{
     "debtIdList": [
          "312D6A5F-2B5A-4694-84DA-F640FC01CC74",
          "E9B42A19-7E70-4E86-98A6-82B6EECC8EE4"
     ],
     "transactionId": 816531486,
     "clientRequestId": "123459"

]
}

🚧

Note que você receberá um erro, pois existe uma distinção no pagamento, ou seja você não deve pagar esses débitos em conjunto.

Criar um pagamento com débito distinto - Sucesso(vehicledebtsapi/v1/payDebts)

{
     "debtIdList": [
          "312D6A5F-2B5A-4694-84DA-F640FC01CC74"
     ],
     "transactionId": 816531487,
     "clientRequestId": "1234509"

]
}

Comprovantes de débitos veiculares

• Exibir comprovante Celcoin disparado via webhook (dos débitos pagos no passo anterior)
• Exibir o comprovante de liquidação enviado (dos débitos pagos no passo anterior)

📘

Após realizar todos os testes e disponibilizar o roteiro para o suporte analisar, as chaves de produção serão liberadas com a aprovação da homologação.

📘

O transactionId e os ids do debtIdList informado acima são apenas exemplos de como montar a chamada. Você deve informar os dados retornados nas consultas realizadas para cada cenário.