A API do Storage foi desenvolvida com o objetivo de permitir que o parceiro solicite a recuperação de XML através de requisições HTTP.
URL
Produção: POST https://storage.ns.eti.br/recovery
Dados de entrada
| Campos | Ocorrência | Descrição | Observação |
|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | Token de Acesso do usuário | |
| CNPJLicenca | 1-1 | CNPJ da licença do emitente | Informar o CNPJ sem os pontos e traços. |
| projeto | 1-1 | Código do Projeto | ANTT: 31 BPe: 27 CTe:6 CTe OS: 26 DDFe: 22 GTVe: 30 MDFe: 21 NF3e: 29 NFCe: 20 NFe: 1 SAT: 24 |
| dataIni | 1-1 | Data inicial do período do resgate. | Ex: “2020-01-01” |
| dataFinal | 1-1 | Data final do período do resgate. | Ex: “2023-01-31” |
| emails | 1-1 | e-mail para receber os arquivos solicitados no resgate |
Exemplo de requisição
Requisição para recuperação dos XMLs por período:
curl -X POST
-H "Content-Type: application/json"
-d '{
"X-AUTH-TOKEN":"…",
"CNPJLicenca": "CNPJ do emitente",
"projeto":"24",
"dataIni":"2022-12-01",
"dataFinal":"2022-12-31",
"emails":[
"email@nstecnologia.com.br"
]' \
https://storage.ns.eti.br/recovery
Exemplos de retorno
{
"status": 200,
"message": "Solicitação de recuperação de XML registrada com
sucesso."
}
Processamento com Erro
//Exemplo 1:
{
"timestamp": "2023-03-06T20:47:19.823+00:00",
"status": 403,
"error": "Forbidden",
"message": "O Access Token deve ser enviado no Corpo, no
Cabecalho da Requisicao ou como Query String (X-AUTH-TOKEN)",
"path": "/recovery"
}
//Exemplo 2:
{
"timestamp": "2023-03-06T20:48:23.772+00:00",
"status": 401,
"error": "Unauthorized",
"message": "Token de acesso inválido",
"path": "/recovery"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Solicitação de recuperação de XML registrada com sucesso. |
| 403 | Forbidden – não informado o token |
| 401 | Unauthorized – Token de acesso inválido |
| 400 | CNPJ da Licença não foi informado |
| 404 | Licenca com cnpj 0000000000000 não encontrada. |
| 500 | Internal Server Error |