# Collection para Postman e Insomnia

Uma collection pronta com todos os endpoints e payloads de exemplo está disponível para download:

[**ixc-edocs-collection.json**](https://api.edocs.ixcsoft.com.br/docs/collections.json)

#### Como importar

**Postman:**

1. Clique em **Import** (ou `Ctrl+O`) e informe a URL `https://api.edocs.ixcsoft.com.br/docs/collections.json`.
2. A collection **IXC E-Docs API** aparecerá na sidebar com os folders e requests organizados.
3. Edite a variável `api_key` na aba **Variables** da collection com a sua chave real.

**Insomnia:**

1. Abra o Insomnia e vá em **Application → Import**.
2. Informe a URL `https://api.edocs.ixcsoft.com.br/docs/collections.json` ou selecione o arquivo salvo localmente.
3. Os requests serão importados organizados por folder.
4. Edite a variável `api_key` no ambiente (Environment) com a sua chave real.

#### Variáveis de ambiente incluídas

| Variável            | Valor padrão                               | Descrição                                                                         |
| ------------------- | ------------------------------------------ | --------------------------------------------------------------------------------- |
| `base_url`          | `https://sandbox.api.edocs.ixcsoft.com.br` | URL base do ambiente. Troque para `https://api.edocs.ixcsoft.com.br` em produção. |
| `api_key`           | `SUA_CHAVE_AQUI`                           | Substitua pela sua `x-api-key`.                                                   |
| `workspace_id`      | `69540c22a40eabd46472f2ad`                 | ID do workspace (ajuste conforme seu ambiente).                                   |
| `company_id`        | `69540ccaa40eabd46472f37e`                 | ID da empresa (ajuste conforme seu ambiente).                                     |
| `nfse_id`           | `6969f22e2af6a5c7ebcb4860`                 | ID de uma NFS-e para consultas e testes.                                          |
| `webhook_id`        | `66a2c9d28d2b45c9f11f8a33`                 | ID de um webhook para consultas e testes.                                         |
| `integration_id`    | `66a2c9d28d2b45c9f11f8a33`                 | ID de uma integração para consultas e testes.                                     |
| `certificate_id`    | `66b2e4f58d2b45c9f11f8b22`                 | ID de um certificado para consultas e testes.                                     |
| `company_reference` | `17081562000100`                           | ObjectId ou CNPJ sem máscara para consulta de empresa.                            |
| `municipality_code` | `4204202`                                  | Código IBGE do município (7 dígitos).                                             |
| `postal_code`       | `89801000`                                 | CEP para consulta de endereço.                                                    |
| `tax_id`            | `17081562000100`                           | CNPJ para consulta cadastral.                                                     |

Todos os requests de escrita (POST/PUT) incluem payloads completos prontos para envio no sandbox. Os query parameters opcionais estão incluídos como desabilitados — ative conforme necessidade.

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ixc-soft.gitbook.io/e-docs/collection-para-postman-e-insomnia.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.