{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c4bbc42b-2249-4eb7-b0d4-a1b08cf23bb1","name":"API REST nsdocs","description":"A API v2 do nsdocs proporciona uma visão abrangente da infraestrutura do serviço, oferecendo uma interface programática padronizada. Com ela, você pode realizar praticamente todas as operações disponíveis no painel, tudo isso na sua linguagem de programação favorita. Baseada em solicitações HTTP e respostas JSON, a API do nsdocs é uma solução RESTful que simplifica a interação com o serviço.\n\nPrincipais operações:\n\n- Enviar documentos e eventos para o nsdocs.\n    \n- Listar dados dos documentos armazenados usando filtros e paginação.\n    \n- Importar documentos como NF-e e CT-e através da Chave de Acesso.\n    \n- Listar dados das empresas cadastradas e consultar a quantidade de créditos disponíveis.\n    \n- Realizar a Pesquisa e Manifestação do Destinatário.\n    \n\n# Autenticação\n\nPara garantir a segurança, esta versão da API utiliza a autenticação do tipo Bearer, exigindo que todas as solicitações sejam criptografadas e enviadas via HTTPS.  \nTodas as chaves de API podem ser restritas a um pequeno conjunto de permissões. Você pode gerar suas chaves de API através do painel web do [nsdocs](https://app.nsdocs.com.br/), no menu `Configurações > Integração via API`.\n\nVocê deve fornecer sua chave no cabeçalho da solicitação para se autenticar na API.\n\n> Authorization: \"Bearer CHAVE_API\" \n  \n\n`Nunca compartilhe suas chaves de API. Mantenha-as protegidas e seguras.`\n\n### **bearerAuth**\n\n| Security Scheme Type | HTTP |\n| --- | --- |\n| HTTP Authorization Scheme | bearer |\n\n# Compressão\n\n### **Descompactando respostas da API**\n\nDurante a operação normal, garantimos que todas as respostas da API sejam compactadas, seja com [GZIP](https://en.wikipedia.org/wiki/Gzip) ou [DEFLATE](https://en.wikipedia.org/wiki/DEFLATE). Ambos os algoritmos são bastante comuns e a maioria das plataformas deve ter ferramentas internas para lidar com a descompactação.\n\nA motivação para isso é simples, servir conteúdo não compactado é uma perda para todas as partes. A largura de banda é, em comparação com o tempo de CPU, excepcionalmente cara e severamente limitada em muitos dispositivos.\n\nEmbora seja verdade que a maioria dos navegadores solicite conteúdo compactado, é importante considerar que muitos dos aplicativos que utilizam nossa API podem não estar totalmente atualizados em relação às melhores práticas de protocolos HTTP. A probabilidade de que algumas aplicações não adotem a compactação, o que pode resultar em um desempenho inferior, é algo que devemos evitar e corrigir.\n\nA API tentará preservar a garantia de compactação em face dos erros, no entanto, é possível que ocorram erros cedo o suficiente na pilha para que a compactação não ocorra. Nesses casos, os erros serão retornados sem compactação.\n\n### **Como consumir corretamente respostas da API**\n\nEm primeiro lugar, sempre defina o cabeçalho Accept-Encoding. Nossa API tentará honrar sua codificação solicitada (GZIP ou DEFLATE), voltando ao GZIP se o cabeçalho não chegar ou for modificado no caminho.\n\nSe Content-Encoding estiver definido na resposta, use o algoritmo especificado. Se estiver faltando, suponha GZIP.\n\nSe a resposta não for compactada, isso sugere que um proxy entre o usuário e nós está descomprimindo intencionalmente o conteúdo ou que erros estão ocorrendo muito cedo nas solicitações de processamento. Você pode detectar conteúdo não compactado verificando os números mágicos apropriados, supondo que sua biblioteca não possa detectar esse erro para você.\n\nA API nunca retornará uma resposta descompactada durante a operação normal.\n\n# Paginação\n\nÉ possível controlar a quantidade e o deslocamento da [Consulta de Documentos](#operation/documentos) especificando os parâmetros `quantidade` e `deslocamento`, sendo que a quantidade máxima de documentos é de 100 registros por requisição.\n\nAlém disso, a API deve retornar no header `X-Total-Registros` a quantidade total de registros retornados.\n\n- `quantidade`: Informe a quantidade de documentos por página. Máximo de 100 documentos.\n    \n- `deslocamento`: Informe o deslocamento da consulta (offset).\n    \n\nDigamos que com base em um filtro informado na consulta, a requisição retorne 6 registros no header `X-Total-Registros`\n\n| Quantidade = 5  <br>Deslocamento = 0 | Quantidade = 3  <br>Deslocamento = 2 | Quantidade = 3  <br>Deslocamento = 4 |\n| --- | --- | --- |\n| Documento 1 | \\- | \\- |\n| Documento 2 | \\- | \\- |\n| Documento 3 | Documento 3 | \\- |\n| Documento 4 | Documento 4 | \\- |\n| Documento 5 | Documento 5 | Documento 5 |\n| \\- | \\- | Documento 6 |\n\n### ⚠️ Importante\n\n> A soma dos valores informados nos parâmetros `quantidade` e `deslocamento` é limitada a 2.000 registros no retorno. Caso seja informado um valor de `deslocamento` que exceda esse limite, os resultados ainda serão limitados a 2.000 registros.  \n  \n**Exemplo**: Se a busca tem 10.000 documentos possíveis e forem informados `quantidade` = 100 e `deslocamento` = 1.950, a chamada retornará os 50 documentos a partir da posição 1.950 até a posição 2.000. Para acessar documentos além desse limite, será necessário ajustar os filtros de busca, como período de data de recebimento ou emissão, ou intervalo de número do documento. Também é possível usar parâmetros de ordenação, como número, data de emissão ou recebimento. \n  \n\n# Tratamento de Erros\n\n| Código HTTP | Descrição |\n| --- | --- |\n| 200 | A solicitação foi concluída com sucesso. |\n| 202 | O servidor está processando a requisição. |\n| 400 | A solicitação não pode ser executada. Geralmente devido a parâmetros malformados ou parâmetros ausentes. |\n| 401 | Falha na autenticação. |\n| 404 | O URL que você enviou está errado. É possível que o recurso que você solicitou tenha sido movido para outro URL. |\n| 500 | O servidor encontrou um erro que impede o cumprimento da solicitação. |\n\nO corpo das mensagens de erro são retornadas no formato JSON na seguinte estrutura:\n\n```\n{\n   'codigo': '400',\n   'descricao': 'Consulta inexistente na base de dados do nsdocs'\n}\n\n ```\n\n# Suporte\n\n[Help Desk](https://servidorseguro.mysuite.com.br/empresas/bso/centralseguro.php?h=65934d5e1ce1244ac6a323d40ff4907f)  \n[Atendimento](https://bsoft.com.br/atendimento)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"29718732","team":5560088,"collectionId":"c4bbc42b-2249-4eb7-b0d4-a1b08cf23bb1","publishedId":"2s9YC5xCPq","public":true,"publicUrl":"https://developer.nsdocs.com.br","privateUrl":"https://go.postman.co/documentation/29718732-c4bbc42b-2249-4eb7-b0d4-a1b08cf23bb1","customColor":{"top-bar":"2E333D","right-sidebar":"C5CAD2","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"API Rest nsdocs"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/0b772728-0e5d-4ffd-86c4-d1afb9036eca/NDJlMDIzNTEtMDhmYy00ZjA4LTk3ZWMtMTBjZmI5NDJiYzYwLnBuZw==","colors":{"top-bar":"FF3D03","right-sidebar":"2e333d","highlight":"c5cad2"}},{"name":"light","logo":"https://content.pstmn.io/4e57b3a8-a00b-49db-86fe-62658dd7a53b/NmViZGI1NjgtNWVlOC00YmI4LWIxMGQtMzNiODBmMmE3NGE0LnBuZw==","colors":{"top-bar":"2E333D","right-sidebar":"C5CAD2","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-12-03T12:32:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"API Rest nsdocs","description":""},"logos":{"logoLight":"https://content.pstmn.io/4e57b3a8-a00b-49db-86fe-62658dd7a53b/NmViZGI1NjgtNWVlOC00YmI4LWIxMGQtMzNiODBmMmE3NGE0LnBuZw==","logoDark":"https://content.pstmn.io/0b772728-0e5d-4ffd-86c4-d1afb9036eca/NDJlMDIzNTEtMDhmYy00ZjA4LTk3ZWMtMTBjZmI5NDJiYzYwLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/a27dfd15c62c58ef70176d1f006b9aa25226c14a835676102c1a164d24a68099","favicon":"https://res.cloudinary.com/postman/image/upload/v1735568042/team/d8dc8e93c160661ec75fb5cd9144b897.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developer.nsdocs.com.br/view/metadata/2s9YC5xCPq"}