{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7b7a9e21-38c7-49ab-aa22-18f8e8dc3578","name":"Documentação API PlugNotas","description":"# PlugNotas API\n\nBem-vindo à **API PlugNotas** — a forma mais simples e moderna de emitir documentos fiscais eletrônicos no Brasil.\n\nAtravés desta API, você pode integrar o seu sistema à **TecnoSpeed PlugNotas**, realizando o envio, consulta e cancelamento de notas fiscais de forma unificada, independentemente do tipo de documento ou da prefeitura.\n\n---\n\n## 🚀 Introdução\n\nA PlugNotas centraliza a comunicação com múltiplos órgãos emissores (prefeituras, SEFAZ e afins), oferecendo uma interface única para:\n\n- **Emissão** de NFS-e, NF-e, NFC-e, MDF-e, CFe e NFCom.\n    \n- **Consulta de status** e recuperação de XMLs/PDFs.\n    \n- **Gerenciamento de certificados digitais e empresas**.\n    \n\nVocê pode testar todas as funcionalidades diretamente por aqui, utilizando o ambiente de **Sandbox** (teste gratuito).\n\n---\n\n## 🌎 Ambientes\n\n| Ambiente | Endpoint Base | Observação |\n| --- | --- | --- |\n| **Sandbox** | `https://api.sandbox.plugnotas.com.br` | Ambiente de testes (mock). Não possui validade fiscal. |\n| **Produção** | `https://api.plugnotas.com.br` | Emissão real de documentos fiscais. |\n\nDefina o valor da variável `{{baseUrl}}` conforme o ambiente desejado.\n\n---\n\n## 🔐 Autenticação\n\nA autenticação é feita via **API Key**, enviada no header de todas as requisições:\n\n``` http\nX-API-KEY: {{apiKey}}\n\n ```\n\n| Chave | Descrição |\n| --- | --- |\n| **`apiKey`** | Token de autenticação da sua conta PlugNotas (gerado no portal). |\n\n> 💡 **Dica:** no Postman, configure a variável `{{apiKey}}` no ambiente _Sandbox_ ou _Produção_.  \nNão compartilhe chaves reais em ambientes públicos. \n  \n\n---\n\n## 🧩 Estrutura da API\n\nA API é organizada por módulos (pastas nesta Collection), cada um correspondente a um tipo de documento ou recurso:\n\n| Módulo | Descrição |\n| --- | --- |\n| **Certificado** | Gerenciamento de certificados digitais. |\n| **Empresa** | Gerenciamento de empresas emitentes. |\n| **NFS-e** | Nota Fiscal de Serviço. |\n| **NFS-e Nacional** | Nota Fiscal de Serviço Nacional. |\n| **NF-e** | Nota Fiscal de Produto (modelo 55). |\n| **NFC-e** | Nota Fiscal do Consumidor (modelo 65). |\n| **MDF-e** | Manifesto Eletrônico de Documentos Fiscais. |\n| **CFe** | Cupom Fiscal Eletrônico. |\n| **NFCom** | Nota Fiscal Fatura de Serviço de Comunicação. |\n\n---\n\n## 🧠 Como começar\n\n1. Gere seu **token de acesso** no portal:  \n    👉 [https://app2.plugnotas.com.br](https://app2.plugnotas.com.br)\n    \n2. baseUrl = [https://api.sandbox.plugnotas.com.brapiKey](https://api.sandbox.plugnotas.com.brapiKey) = SEU_TOKEN_AQUI\n    \n3. Teste as rotas nesta ordem recomendada:\n    \n    - Cadastrar certificado digital\n        \n    - Cadastrar empresa\n        \n    - Emitir documento (NFS-e, NF-e, NFC-e...)\n        \n    - Consultar status da nota\n        \n\n---\n\n## 🧾 Formato das Requisições\n\nAs requisições são enviadas em **JSON** (ou `multipart/form-data` no caso de certificados).  \nAs respostas seguem o formato padrão:\n\n``` json\n{\n  \"id\": \"abcd1234\",\n  \"status\": \"processando\",\n  \"mensagem\": \"Nota enviada com sucesso\",\n  \"protocolo\": \"123456789\"\n}\n\n ```\n\n> Campos adicionais podem variar conforme o tipo de documento e o padrão da prefeitura/SEFAZ. \n  \n\n---\n\n## 📬 Códigos de Retorno\n\n| Código | Descrição |\n| --- | --- |\n| **200** | Requisição processada com sucesso. |\n| **202** | Requisição aceita, processamento assíncrono. |\n| **400** | Dados inválidos na requisição. |\n| **401** | Falha de autenticação (`X-API-KEY` ausente ou inválido). |\n| **404** | Documento ou recurso não encontrado. |\n| **500** | Erro interno do servidor. |\n\n---\n\n## 🧠 Dicas e Boas Práticas\n\n- Sempre **salve o** **`id`** **retornado** nas emissões — ele será usado para consultas posteriores.\n    \n- Utilize **ambiente Sandbox** para testes iniciais e homologação.\n    \n- Para erros específicos, consulte o campo `mensagem` retornado no JSON.\n    \n- Configure o Postman para **exibir o console** (Ctrl + Alt + C) ao testar rotas.\n    \n\n---\n\n## 📚 Recursos Úteis\n\n- Portal PlugNotas: [https://plugnotas.com.br](https://plugnotas.com.br)\n    \n- Painel do Cliente: [https://app2.plugnotas.com.br](https://app2.plugnotas.com.br)\n    \n- Documentação técnica: [https://docs.plugnotas.com.br](https://docs.plugnotas.com.br)\n    \n- Central de ajuda: [https://atendimento.tecnospeed.com.br/hc/pt-br/categories/360001354313](https://atendimento.tecnospeed.com.br/hc/pt-br/categories/360001354313)\n    \n\n---\n\n## 📞 Suporte Técnico\n\nCaso tenha dúvidas, entre em contato:\n\n**TecnoSpeed S/A – PlugNotas**  \n📧 E-mail: [contato@tecnospeed.com.br](https://mailto:contato@tecnospeed.com.br)  \n🌐 Site: [https://plugnotas.com.br](https://plugnotas.com.br)\n\n---\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3720339","team":11350062,"collectionId":"7b7a9e21-38c7-49ab-aa22-18f8e8dc3578","publishedId":"2sB3WpSh1R","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3720339/2sB3WpSh1R","privateUrl":"https://go.postman.co/documentation/3720339-7b7a9e21-38c7-49ab-aa22-18f8e8dc3578","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Documentação da API PlugNotas para emissão e consulta de documentos fiscais eletrônicos (NFSe, NFe, NFCe, NFCom)."},{"name":"title","value":"Documentação da API PlugNotas"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2025-11-06T18:28:01.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Documentação da API PlugNotas","description":"Documentação da API PlugNotas para emissão e consulta de documentos fiscais eletrônicos (NFSe, NFe, NFCe, NFCom)."},"logos":{"logoLight":null,"logoDark":null}},"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/fa0543c26b00d8e28c3cd95052a1b9a221d1a2d786e61169586d5604d42fce04","favicon":""},"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://documenter.gw.postman.com/view/metadata/2sB3WpSh1R"}