Roteiro de Integração de escrituração de notas comerciais
O roteiro de homologação descreve todos os recursos e funcionalidades que precisam ser testados pelo parceiro integrador no ambiente de sandbox da QI Tech (ambiente de testes), antes da entrada em ambiente de produção para emissão de notas comerciais.
Este roteiro descreve todos os recursos e funcionalidades envolvidos no produto.
Todos os testes devem ser obrigatoriamente realizados no ambiente de Sandbox da QI Tech (ambiente de testes). As operações realizadas em ambiente de Sandbox são operações financeiras fictícias, servindo apenas para teste de funcionalidade das APIs.
Cadastro e Autenticação API Escrituração
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| CAB0001* | Troca de chaves públicas | Realizar a troca de chaves públicas com o time operações de plataforma (suporte.dcm@qitech.com.br) | Link Documentação | |
| CAB0002* | Teste de autenticação de chamadas | Após receber a chave de api com o time de plataformas, finalizar teste de autenticação de chamadas | Link Documentação Link Documentação | CAB0001 |
| CAB0003* | Configuração de webhooks | Realizar a configuração da url para envio dos webhooks por parte da QI. | Link Documentação Link Documentação Link Documentação | CAB0001 e CAB0002 |
Homologação do Emissor
Para o fluxo de homologação do emissor, caso o cliente já tenha realizado a integração com o cadastros de cedentes QI TECH, é possível reutilizar esses cadastros, simplificando a homologação no sistema de escrituração
Homologação do emissor para cadastros feitos no sistema de cedentes QI TECH
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| CED1001* | Reaproveitar cadastro cedente | Realizar o reaproveitamento do cadastro de cedente utilizando o CNPJ do mesmo. | Link Documentação | |
| CED1002* | Listagem dos emissores cadastrados | Listagem dos cedentes cadastrados, com filtros por CNPJ, nome | Link Documentação | |
| CED1003* | Detalhes do emissor | Visualizar os detalhes de um emissor cadastrado, por issuer_key | Link Documentação |
Homologação do Investidor
Para o fluxo de homologação do investidor, caso o cliente tenha fundos fixos, é possível realizar o cadastro desses no setup, simplificando a integração.
Homologação do investidor para cadastros feitos no setup
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| INV1001* | Listagem dos investidores cadastrados | Listagem dos fundos cadastrados, com filtros por CNPJ, nome | Link Documentação | |
| INV1002* | Detalhes do investidor | Visualizar os detalhes de um investidor cadastro, por investor_key | Link Documentação |
Emissão de nota comercial
Após os cadastros de emissores e investidores, é possível realizar a emissão de notas comerciais. Para isso, existem algumas combinações de fluxos de emissão, que serão contempladas abaixo.
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| COM0001 | Simulação de condições financeiras | simular as condições financeiras e o fluxo de pagamentos de uma operação | Link Documentação | |
| COM0002* | Cadastro de Operação de Nota Comercial | criar uma nova operação de nota comercial com base nos dados financeiros e de investidores. | Link Documentação | COM0001 |
| COM0002 | ||||
| COM003* | Enviar Operação para Análise | alterar o status de uma operação para "em análise", enviando-a para o processo de validação de compliance pelo escriturador | Link Documentação | COM0002 |
| COM004* | Enviar Contratos Assinados | Este endpoint permite enviar os contratos assinados de forma externa para o sistema de escrituação, enviando um base64 que será analisado e aprovado pelo escriturador. | Link Documentação | COM0002 |
| COM0005 | Consulta de Operações por Filtros | consultar operações de nota comercial utilizando filtros opcionais | Link Documentação | COM0002, COM0003, COM0004 |
| COM0006 | Consulta de Operação por Chave | consultar os detalhes completos de uma operação específica, utilizando sua chave única. | Link Documentação | COM0002, COM0003, COM0004 |
Mapeamento de erros
Os erros originários das apis de emissores, investidores e nota comercial podem ser encontrados em Link Catálogo de Erros