API RESTful: Iniciando os testes

Antes de iniciar é necessário ler a documentação abaixo.

📘 DOCUMENTAÇÃO 

Seguem abaixo as etapas para poder realizar os testes da integração via API.

1. Para poder realizar os testes, recomendamos a utilização do sistema Postman

2. Como exemplo de teste vamos utilizar a requisição abaixo:

3. No Postman, informe os parâmetros conforme demonstrado abaixo para poder consultar o Resumo das NF-e's.

cnpjCpf: {Cnpj/Cpf da empresa que será consultada}

dataInicial: Data de emissão inicial do período da NF-e (formato yyyy-MM-dd)

dataFinal: Data de emissão final do período da NF-e (formato yyyy-MM-dd)

modelo: 55 (NF-e), 65 (NFC-e) ou 59 (Sat)

4. Agora no HEADER informe os tokens de acesso da autenticação conforme demonstrado abaixo.

5. Clique no botão Send.

6. Pronto, será retornada a resposta da requisição com as informações preenchidas nos campos.

Perguntas frequentes

1. É 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.

2. Como obter os tokens de acesso da autenticação?

Entre em contato com nosso atendimento para maiores informações.

3. Como implantar no meu software?

Neste caso é necessário passar esta documentação para o setor responsável do seu software para poder realizar a implantação.

4. Como testar o exemplo acima utilizando a linguagem de programação C#?

Segue abaixo um exemplo.

var client = new RestClient("http://api.espiaonfe.com.br");

var request = new RestRequest("/v1-cloud/consulta/periodo/nfe-resumo", Method.GET);

request.AddHeader("esp-cloud-token", {Informe o token de acesso da conta});

request.AddHeader("user-token", {Informe o token de acesso do usuário});

request.AddParameter(cnpjCpf", 99999999999999);

request.AddParameter(dataInicial", 2022-08-01);

request.AddParameter(dataFinal", 2022-08-25);

request.AddParameter(modelo", 55);

IRestResponse response = client.Execute(request);