> ## 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

## URL Base

A API de Certificados ZapSign é baseada em princípios REST. Exigimos o uso de HTTPS em todas as requisições para garantir segurança, integridade e privacidade dos dados. A API não oferece suporte a HTTP.

Todas as requisições devem utilizar a seguinte URL base:

```text theme={null}
https://certificados.zapsign.com.br
```

## Autenticação

Para autenticação, você deve incluir um header Authorization na requisição, com o valor Bearer czk\_xxxxxxxx, onde czk\_xxxxxxxx é a sua API Key.

```text theme={null}
Authorization: Bearer czk_xxxxxxxx
```

## Códigos de Resposta

A Certificados ZapSign utiliza códigos HTTP padrão para indicar o sucesso ou falha das requisições.

Em geral, códigos na faixa 2xx indicam sucesso, códigos 4xx indicam erros relacionados à requisição do usuário e códigos 5xx indicam falhas na infraestrutura do sistema.

| Status | Descrição                                                               |
| ------ | ----------------------------------------------------------------------- |
| `200`  | Requisição bem-sucedida.                                                |
| `400`  | Verifique se os parâmetros estão corretos.                              |
| `401`  | A chave de API não foi informada.                                       |
| `402`  | Pagamento necessário ou saldo insuficiente para processar a requisição. |
| `403`  | Parceiro não aprovado.                                                  |
| `404`  | Recurso não encontrado.                                                 |
| `409`  | ID já utilizado para este parceiro.                                     |
| `429`  | Limite de requisições excedido (rate limit).                            |
| `5xx`  | Indica um erro nos nossos servidores.                                   |

<Info>
  Consulte os [Códigos de Erro](/api-reference/erro) para uma descrição completa de todos os possíveis erros da API.
</Info>