Roteiro de Integração — API de Escrituração de Notas Comerciais (NC) com Auto-Assinatura
Este roteiro descreve todos os recursos e funcionalidades que precisam ser testados pelo parceiro integrador no ambiente de Sandbox da QI Tech, antes da entrada em ambiente de produção para emissão de notas comerciais (NC).
Trata-se de uma versão personalizada do roteiro padrão de integração de NC da QI Tech, adaptada para o fluxo de emissão totalmente automatizado: uma vez que o emissor esteja cadastrado, aprovado e habilitado para auto-assinatura, todas as emissões seguintes ocorrem de ponta a ponta via API, sem etapa manual de assinatura.
Todos os testes devem ser obrigatoriamente realizados no ambiente de Sandbox da QI Tech. As operações realizadas em ambiente de Sandbox são operações financeiras fictícias, servindo apenas para teste de funcionalidade das APIs.
1. Escopo e fases
O fluxo é dividido em seis fases. As fases 0 a 4 se apoiam em funcionalidades já disponíveis na API. A fase de habilitação da auto-assinatura (Fase 2) depende de novo desenvolvimento do lado da QI Tech. A Fase 6 é dividida em duas: a transferência de recursos para a conta de liquidação da WL (6.1) utiliza endpoints de BaaS que já existem e podem ser homologados hoje; o pagamento ao fornecedor (6.2) depende de novo desenvolvimento.
| Legenda | Significado |
|---|---|
| ✅ | Disponível hoje — pode ser homologado em Sandbox imediatamente |
| 🆕 | Novo desenvolvimento — contrato do endpoint a ser publicado; a homologação começa após a liberação |
| ⚙️ | Executado pela QI Tech (sem ação do integrador, mas o integrador precisa observar o status resultante) |
* | Etapa obrigatória para o aceite da homologação |
A auto-assinatura só é configurada após a aprovação do cadastro do emissor. O termo de adesão que a autoriza é assinado dentro do pacote da primeira emissão. A partir da segunda emissão, a assinatura do lado do emissor é totalmente automática. A Fase 2 é, portanto, um portão único por emissor, e não uma etapa por operação.
2. Fluxo ponta a ponta
3. Fase 0 — Cadastro e autenticação na API
| Código | Etapa | Descrição | Documentação | Pré-requisito | Status |
|---|---|---|---|---|---|
| CAB0001* | Troca de chave pública | Realizar a troca de chave pública com o time de operações da plataforma (suporte.dcm@qitech.com.br) | Documentação | — | ✅ |
| CAB0002* | Teste de autenticação | Após o recebimento da chave de API, realizar os testes de autenticação de chamada | Documentação Documentação | CAB0001 | ✅ |
| CAB0003* | Configuração de webhooks | Configurar a URL para a qual a QI Tech enviará os webhooks | Documentação Documentação Documentação | CAB0001, CAB0002 | ✅ |
Neste fluxo, a configuração de webhooks é obrigatória, e não opcional. Como a análise, a aprovação e a assinatura são automáticas, o integrador não possui nenhum ponto de conferência manual — os webhooks são a única forma de acompanhar o avanço da operação sem polling.
4. Fase 1 — Homologação do emissor
Caso o cliente já tenha realizado a integração com os cadastros de cedente da QI Tech, é possível reutilizar esses cadastros, o que simplifica consideravelmente a homologação no sistema.
4.1 Fase 1A — Emissor cadastrado no sistema de cedentes da QI Tech
| Código | Etapa | Descrição | Documentação | Pré-requisito | Status |
|---|---|---|---|---|---|
| CED1001* | Reutilizar cadastro de cedente | Reutilizar um cadastro de cedente existente por CNPJ | Documentação | CAB0002 | ✅ |
| CED1002* | Listar emissores cadastrados | Listar os emissores cadastrados, filtrando por CNPJ ou nome | Documentação | CED1001 | ✅ |
| CED1003* | Detalhes do emissor | Consultar os detalhes de um emissor cadastrado pela issuer_key | Documentação | CED1001 | ✅ |
4.2 Fase 1B — Emissor cadastrado pelo sistema
| Código | Etapa | Descrição | Documentação | Pré-requisito | Status |
|---|---|---|---|---|---|
| CED0001* | Cadastro básico do emissor | Criar o emissor com seus dados cadastrais básicos | Documentação | CAB0002 | ✅ |
| CED0002* | Upload / remoção de documentos do emissor | Anexar e remover documentos associados a um emissor cadastrado | Documentação Documentação | CED0001 | ✅ |
| CED0003* | Cadastro / remoção de representantes do emissor | Adicionar e remover representantes associados a um emissor cadastrado | Documentação Documentação | CED0001 | ✅ |
| CED0004* | Upload / remoção de documentos de representantes | Anexar e remover documentos associados a um representante de um emissor cadastrado | Documentação Documentação | CED0001, CED0003 | ✅ |
| CED0005* | Cadastro / remoção de conta bancária do emissor | Adicionar e remover uma conta bancária associada a um emissor cadastrado | Documentação Documentação | CED0001 | ✅ |
| CED0006* | Cadastro / remoção de grupos de assinantes do emissor | Adicionar e remover grupos de assinantes associados a um emissor cadastrado | Documentação Documentação | CED0001, CED0003 | ✅ |
| CED0007* | Cadastro / remoção de informações de contato do emissor | Adicionar e remover informações de contato associadas a um emissor cadastrado | Documentação Documentação | CED0001 | ✅ |
| CED0008* | Envio do emissor para análise | Mover o emissor para o status de análise, enviando-o ao processo de validação | Documentação | CED0001 → CED0007 | ✅ |
| CED0009* | Alteração do cadastro do emissor | Reabrir o emissor para edição | Documentação | CED0001 → CED0007 | ✅ |
| CED0010* | Listar emissores cadastrados | Listar os emissores cadastrados, filtrando por CNPJ ou nome | Documentação | CED0001 | ✅ |
| CED0011* | Detalhes do emissor | Consultar os detalhes de um emissor cadastrado pela issuer_key | Documentação | CED0001 | ✅ |
O grupo de assinantes cadastrado em CED0006 define qual representante assinará em nome do emissor. Esse mesmo representante é quem assina o termo de adesão da auto-assinatura na Fase 2 e cuja alçada o certificado privado representa. Cadastre-o corretamente antes de enviar o emissor para análise — uma alteração posterior exige repetir a Fase 2.
5. Fase 2 — Habilitação da auto-assinatura 🆕
Esta fase é a nova funcionalidade que viabiliza o fluxo automatizado. Ela ocorre uma única vez por emissor, após a aprovação do cadastro do emissor, e resulta em um certificado privado da QI Tech com escopo exclusivo aos documentos de NC desta integração.
O que o termo de adesão autoriza. Ele concede à QI Tech um mandato limitado para emitir e custodiar um certificado privado interno, liberado na CertifiQI, a ser utilizado exclusivamente para assinar os documentos deste fluxo de NC em nome do emissor — nunca para qualquer outro documento, produto ou contraparte. É assinado uma única vez, com biometria de reconhecimento facial, pelo representante cadastrado em CED0006.
Quando é assinado. O termo é incluído no pacote da primeira emissão. A primeira operação, portanto, ainda possui uma etapa de assinatura humana; a partir da segunda operação, a assinatura do lado do emissor é totalmente automática.
| Código | Etapa | Descrição | Documentação | Pré-requisito | Status |
|---|---|---|---|---|---|
| ASG0001* | Consultar elegibilidade para auto-assinatura | Ler o bloco signature_configuration do emissor para confirmar que ele está aprovado e elegível à habilitação de auto-assinatura | Documentação (pendente de publicação) | CED0011 ou CED1003 | 🆕 |
| ASG0002* | Solicitar habilitação de auto-assinatura | Solicitar a habilitação para um emissor aprovado, indicando o grupo de assinantes e o representante que assinará o termo de adesão. Retorna uma auto_signature_key no status pending_agreement | Documentação (pendente de publicação) | ASG0001, CED0006 | 🆕 |
| ASG0003* | Consultar link de assinatura do termo de adesão | Consultar o link pelo qual o representante assina o termo de adesão com reconhecimento facial. Na primeira emissão, esse link é entregue como parte do pacote de assinatura da operação | Documentação (pendente de publicação) | ASG0002 | 🆕 |
| ASG0004* | Webhook — termo de adesão assinado | Receber o webhook que confirma que o termo de adesão foi assinado e validado | Documentação (pendente de publicação) | CAB0003, ASG0003 | 🆕 |
| ASG0005 | Emissão do certificado privado | A QI Tech cria o certificado privado e o libera na CertifiQI, com escopo restrito aos documentos de NC deste emissor. Hoje é manual (uma única vez por emissor, executado pela QI Tech); a automação via API está no roadmap e não bloqueia o go-live | — | ASG0004 | ⚙️ 🆕 |
| ASG0006* | Consultar status da auto-assinatura | Consultar a habilitação pela auto_signature_key ou pela issuer_key e confirmar a transição para active. Nenhuma NC pode depender da assinatura automática antes de esse status ser atingido | Documentação (pendente de publicação) | ASG0002 | 🆕 |
| ASG0007* | Webhook — auto-assinatura ativa | Receber o webhook que sinaliza que o certificado está disponível e o emissor está habilitado para assinatura automática | Documentação (pendente de publicação) | CAB0003, ASG0005 | 🆕 |
| ASG0008 | Consultar termo de adesão assinado | Consultar o documento do termo de adesão assinado para registro e trilha de auditoria do próprio integrador | Documentação (pendente de publicação) | ASG0004 | 🆕 |
| ASG0009 | Revogar auto-assinatura | Revogar a habilitação e o certificado associado — necessário quando o representante muda, quando o grupo de assinantes é alterado ou a pedido do emissor. Após a revogação, as emissões voltam ao fluxo de assinatura manual até que a Fase 2 seja repetida | Documentação (pendente de publicação) | ASG0006 | 🆕 |