> ## Documentation Index
> Fetch the complete documentation index at: https://docs.certificados.zapsign.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> API para parceiros criarem e acompanharem protocolos de certificado digital.

Crie e acompanhe protocolos de e-CPF e e-CNPJ pelo seu sistema. A API oferece certificados A1 e A3 em nuvem. Depois de gerar o protocolo, compartilhe o número com o titular. Compartilhe também o link de atendimento, quando disponível.

## Termos

| Termo | Significado |
| - | - |
| Parceiro | Você, dono da chave de API. |
| Titular | Quem recebe o certificado. No e-CPF, é a pessoa. No e-CNPJ, é a empresa. |
| Representante legal | Campo `representative`. A pessoa que faz a videoconferência do e-CNPJ. |
| Protocolo | O pedido de um certificado. Tem `protocol_id` e, depois de gerado, `protocol_number`. |
| Saldo | Quantos certificados você ainda pode criar. `GET /credits` retorna esse número em `credits_available`. |

## Como começar

Veja a URL base, a autenticação e os limites na [Referência da API](https://docs.certificados.zapsign.com.br/api-reference/introducao.md). Para fazer a primeira chamada, siga o [Início rápido](https://docs.certificados.zapsign.com.br/quickstart.md).

> [!WARNING]
>
> Não há ambiente de testes. Só existem chaves `czk_live_`, e a criação de protocolo desconta o seu saldo real. Veja [Saldo](#saldo).

## Saldo

| Chamada | Efeito no saldo |
| - | - |
| `POST /protocols` | Desconta 1 certificado. |
| `POST /protocols/{protocol_id}/cancel` | Devolve 1 certificado quando o cancelamento é confirmado (`status` igual a `cancelled`). |
| `POST /protocols/{protocol_id}/appointment` | Não consome. |
| `POST /customer-verifications` | Não consome. |
| `GET /credits`, `GET /protocol-products`, `GET /appointment-slots`, `GET /protocols`, `GET /protocols/{protocol_id}` | Não consomem. |

Se a criação falhar (`creation_failed`), nada é descontado.

## Para agentes de IA

Esta documentação oferece formatos próprios para agentes:

* `/llms.txt`: índice das páginas.
* `/llms-full.txt`: o conteúdo completo da documentação em um arquivo.
* `/api-reference/openapi.json`: a especificação OpenAPI.
* Sufixo `.md`: adicione `.md` ao endereço de uma página para ler o conteúdo em Markdown, como `/quickstart.md`.

Todos usam o domínio `https://docs.certificados.zapsign.com.br`. O menu da página também abre o conteúdo no ChatGPT, no Claude e no Perplexity.

## Próximos passos

> [card] [Início rápido](https://docs.certificados.zapsign.com.br/quickstart.md)
>
> Do saldo ao protocolo cancelado, passo a passo.

> [card] [Ciclo de vida](https://docs.certificados.zapsign.com.br/ciclo-de-vida-do-protocolo.md)
>
> Os 6 status do protocolo e o que fazer em cada um.

> [card] [Idempotência](https://docs.certificados.zapsign.com.br/idempotencia.md)
>
> Reenvie com segurança, sem duplicar protocolos.

> [card] [Erros](https://docs.certificados.zapsign.com.br/erros.md)
>
> Formato dos erros e o que fazer em cada código.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.