# Perguntas frequentes (FAQ)

### Como faço para acessar a documentação da API?

É só acessar: <https://api.espiaonfe.com.br/>

***

### **É possível testar a API no período de testes do Espião Cloud?**

Não. Para poder utilizar a API é necessário tem algum plano do Espião Cloud contratado.

***

### **Como obter os tokens de acesso da autenticação?**

Para obter os tokens de acesso, é só acessar conforme abaixo:

<div align="left"><figure><img src="https://1086762934-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqoJpeeYAUN8570QfuPzY%2Fuploads%2FvKZ0jTaETTpKSOreYxkB%2Facessar-tokens-api.png?alt=media&#x26;token=76c492d4-4ef5-46d1-8cac-42fafe46f456" alt=""><figcaption></figcaption></figure></div>

***

### **Como implantar no meu software?**

Neste caso é necessário passar [esta documentação](http://api.espiaonfe.com.br/) para o setor responsável do seu software para poder realizar a implantação.

***

### **Qual a diferença entre API Histórico DF-e, API Consulta NFS-e e API Resgate XML?**

Ao analisar os planos do Espião Cloud, você irá notar que há plano que permite a utilização da ***API*** ***Histórico DF-e***,  ***API Consulta NFS-e e API Resgate XML***.

#### **API Histórico DF-e**

Permite utilizar todos os recursos demonstrados na [documentação](https://api.espiaonfe.com.br/), exceto o acesso para *Nota Fiscal de Serviço (NFS-e) - Consulta em tempo real*

#### **API Consulta NFS-e**

Permite o acesso para utilizar a ***Nota Fiscal de Serviço (NFS-e) - Consulta em tempo real*****.**

Esta funcionalidade permite realizar as consultas em tempo real diretamente no município informado.

<div align="left"><figure><img src="https://1086762934-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqoJpeeYAUN8570QfuPzY%2Fuploads%2FUCrp6FT4g9Fk1qLzrsTB%2Fapi-consultar-nfse-tempo-real.png?alt=media&#x26;token=56f3c822-51da-4272-b54e-dc6c3f320b0a" alt=""><figcaption></figcaption></figure></div>

#### API Resgate XML

Recupera o XML da sua Nota Fiscal direto da SEFAZ, mesmo para notas emitidas há até 11 anos atrás, usando apenas as chaves de acesso.

***

### É possível fazer a consulta direta na SEFAZ pela **API Histórico DF-e**?

Não. Através da **API Histórico DF-e** só é possível consultar os documentos que já foram consultados na SEFAZ pela plataforma Espião Cloud.

O Espião Cloud adota tratamentos específicos para atender às regras da SEFAZ, incluindo medidas para evitar o consumo indevido.

#### Consulta manual

Para realizar uma consulta manual na SEFAZ, só é possível através da plataforma Espião Cloud, de acordo especificado no manual [Consultar na SEFAZ](https://ajuda.espiaonfe.com.br/gestao/nf-e/consultas-na-sefaz/certificado-a1)

Através da API, não é possível fazer a consulta manual na SEFAZ.

#### Consulta automática

A consulta automática irá buscar as notas de entradas (emitidas contra o CNPJ) diretamente na SEFAZ Nacional em horários específicos definidos pelo usuário, podendo ser: **Padrão, Manhã, Tarde ou Noite.**

Contudo, no caso das consultas automáticas, essa configuração será válida apenas para empresas que utilizam o [certificado do tipo A1](https://blog.espiaonfe.com.br/o-que-e-certificado-digital-para-que-serve/)

Para maiores informações sobre a consulta automática, acesse:[ Consulta automática](https://ajuda.espiaonfe.com.br/gestao/nf-e/configuracoes/consulta-automatica)

#### Configurar a consulta automática através da API

Através da API, também é possível configurar horários específicos de consulta na SEFAZ para cada empresa.

Através do parâmetro **periodoConsultaAutoNfe** das requisições abaixo, você especifica o período desejado.

`POST`
\
`/v1-cloud/empresas/empresa`
\
`Cadastra uma nova empresa`

`PUT`
\
`/v1-cloud/empresas/empresa/{cnpjCpf}`
\
`Atualiza os dados da empresa`

***

### Quais são as regras da SEFAZ para consultar NF-e?

Par maiores informações sobre as regras da SEFAZ, acesse: [📘 Regras da SEFAZ](https://ajuda.espiaonfe.com.br/gestao/nf-e/consultas-na-sefaz#regras-da-sefaz)