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

# Introdução

> Consulte Notas Fiscais Eletrônicas utilizando nossa API REST

## Visão Geral

A **API de Consulta NF-e** permite a consulta de **Notas Fiscais Eletrônicas (NF-e)** utilizando a chave de acesso. Para acessar os endpoints da API, é necessário um **token de autenticação** que pode ser gerado no painel administrativo.

## Autenticação na API

### Obtendo o Token de Acesso

Para consumir a API, você precisa gerar um **API Token**:

<Steps>
  <Step title="Acesse o Dashboard">
    Vá para [admin.validanfe.com](https://admin.validanfe.com)
  </Step>

  <Step title="Faça Login">
    Entre com seu usuário e senha
  </Step>

  <Step title="Navegue até Configurações">
    Acesse **Configurações > API Token**
  </Step>

  <Step title="Gere o Token">
    Crie um novo **API Token** e copie-o
  </Step>
</Steps>

### Utilizando o Token

Todas as requisições para a API devem conter o token no cabeçalho `X-API-KEY`:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.validanfe.com/NFe/ConsultarNFe/35170608530528000184550000000154301000771561" \
    -H "Accept: application/json" \
    -H "X-API-KEY: SEU_API_TOKEN_AQUI"
  ```

  ```http HTTP Headers theme={null}
  GET /NFe/ConsultarNFe/{chave}
  Host: api.validanfe.com
  X-API-KEY: SEU_API_TOKEN_AQUI
  Accept: application/json
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.validanfe.com/NFe/ConsultarNFe/{chave}', {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-API-KEY': 'SEU_API_TOKEN_AQUI'
    }
  });

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.validanfe.com/NFe/ConsultarNFe/{chave}"
  headers = {
      "Accept": "application/json",
      "X-API-KEY": "SEU_API_TOKEN_AQUI"
  }

  response = requests.get(url, headers=headers)
  data = response.json()
  ```
</CodeGroup>

## Rate Limiting

<Warning>
  **Limite de Requisições**

  Para garantir a estabilidade da API, aplicamos um limite de **5 chamadas por minuto**.
  Caso excedido, você receberá o status **429 Too Many Requests**.
</Warning>

<Info>
  **Chaves de Teste Gratuitas**

  As chaves de teste podem ser usadas **em produção** sem custos ou consumo do seu pacote.
</Info>

## Chaves de Teste

Use estas chaves para testar a API sem custos:

| Chave NF-e                                     | Observação                                  |
| ---------------------------------------------- | ------------------------------------------- |
| `87878774456468954646464654654546545446579312` | NF-e contendo todos os arrays               |
| `35220241522703000167550010000001211000225472` | NF-e contendo evento de cancelamento        |
| `22210841816302000110550000000000012824578529` | NF-e autorizada fora do prazo (`cstat 150`) |
| `41220211436073000147550010013215511002385213` | NF-e com uso denegado (`cstat 302`)         |

## Base URL

A URL base para todos os endpoints da API NFe é:

```
https://api.validanfe.com
```

## Próximos Passos

<CardGroup cols={2}>
  <Card title="NFe Resumida" href="/validanfe-api/api-nfe/nfe-resumida">
    Consulte informações básicas da NFe
  </Card>

  <Card title="NFe Completa" href="/validanfe-api/api-nfe/nfe-full">
    Consulte dados completos da NFe
  </Card>

  <Card title="Webhook Subscriptions" href="/validanfe-api/api-nfe/webhooks-subscriptions">
    Configure notificações automáticas
  </Card>

  <Card title="Webhook Deliveries" href="/validanfe-api/api-nfe/webhooks-deliveries">
    Monitore entregas de webhooks
  </Card>
</CardGroup>

<Note>
  **Precisa de Ajuda?**

  Entre em contato: [suporte@validanfe.com](mailto:suporte@validanfe.com)
</Note>
