# Webmania API documentation

> Official API references in Markdown, rendered from the same content as the human documentation.

Choose the product first: NF-e ≠ NFC-e ≠ NFCom. API versions, identifiers and authentication differ by product; preserve identifiers as strings and leading zeros.

API 1.0 company and reseller flows require all four headers: `X-Consumer-Key`, `X-Consumer-Secret`, `X-Access-Token`, `X-Access-Token-Secret`. Use the credentials of the documented company or reseller flow, never interchange them. API 2.0 fiscal operations use `Authorization: Bearer`; CEP / IBGE uses `X-Token`. Keep credentials in your backend, outside source control and browser code.

Read the selected operation's full parameter tables and company, certificate and subscription prerequisites. For NFS-e, `GET /2/nfse/status` reports provider capabilities. Use homologação (`ambiente: 2`) only where the operation/provider supports it; never silently fall back to production. Fiscal example values are illustrative, not tax advice.

Inspect both HTTP status and JSON: validation failures can return HTTP 200 with `error`; other failures can use `msg` or `message`, and `message` may also be informational. HTTP success or a UUID does not prove fiscal authorization. Track processing/contingency through the product's consultation and notifications instead of issuing again after a timeout.

Persist document identifiers, distinguish NFS-e batch and document UUIDs, and handle repeated notifications idempotently. For NFS-e, follow the documented `atualizado_em` ordering. After an ambiguous timeout, consult the existing document with the supported identifier before retrying; do not invent an `Idempotency-Key` header or assume every POST/PUT is safe to repeat. Download XML/PDF through the documented authenticated mechanism, with a binary parser rather than a JSON parser.

References are large (the NF-e page exceeds 400 KB). Read them in parts: open the reference's section index (`?format=markdown&indice=1`, every section with its URL and size), then fetch only the sections you need with `?format=markdown&secao=SECTION_ID` and follow linked field tables. The full page remains available at `?format=markdown`. Illustrative `text` blocks are not executable JSON. Restricted references retain their entitlement and cache rules; request them with an authorized session on their original URL.

## Documentos fiscais

- [NF-e / NFC-e](https://webmania.com.br/docs/rest-api-nfe/?format=markdown): API 1.0 · Four X-Consumer / X-Access headers · documentação v3.0.1 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-nfe/?format=markdown&indice=1).
- [NFS-e](https://webmania.com.br/docs/rest-api-nfse/?format=markdown): API 2.0 · Authorization: Bearer · documentação v3.1.3 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-nfse/?format=markdown&indice=1).
- [NFCom](https://webmania.com.br/docs/rest-api-nfcom/?format=markdown): API 2.0 · Authorization: Bearer · documentação v2.0.3 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-nfcom/?format=markdown&indice=1).
- [DC-e](https://webmania.com.br/docs/rest-api-dce/?format=markdown): API 2.0 · Authorization: Bearer · documentação v2.0.1 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-dce/?format=markdown&indice=1).

## Transporte

- [CT-e](https://webmania.com.br/docs/rest-api-cte/?format=markdown): API 2.0 · Authorization: Bearer · documentação v1.2.2 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-cte/?format=markdown&indice=1).
- [MDF-e](https://webmania.com.br/docs/rest-api-mdfe/?format=markdown): API 2.0 · Authorization: Bearer · documentação v1.4.3 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-mdfe/?format=markdown&indice=1).
- [CIOT](https://webmania.com.br/docs/rest-api-ciot/?format=markdown): API 2.0 · Authorization: Bearer; approved operations only · documentação v2.0.1 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-ciot/?format=markdown&indice=1).

## Guias e tributos

- [GNRE](https://webmania.com.br/docs/rest-api-gnre/?format=markdown): API 2.0 · Authorization: Bearer · documentação v2.14.2 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-gnre/?format=markdown&indice=1).
- [DARE ICMS SP](https://webmania.com.br/docs/rest-api-dare-icms-sp/?format=markdown): API 2.0 · Authorization: Bearer · documentação v1.0.2 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-dare-icms-sp/?format=markdown&indice=1).
- [DUA ES](https://webmania.com.br/docs/rest-api-dua-es/?format=markdown): API 2.0 · Authorization: Bearer · documentação v1.0.2 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-dua-es/?format=markdown&indice=1).

## Gestão

- [Monitor Fiscal](https://webmania.com.br/docs/rest-api-monitor-fiscal/?format=markdown): API 2.0 · Authorization: Bearer (token do Monitor Fiscal) · documentação v2.2.6 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-monitor-fiscal/?format=markdown&indice=1).
- [Gerencial B2B](https://webmania.com.br/docs/rest-api-gerencial-b2b/?format=markdown): API 1.0 · Four reseller X-Consumer / X-Access headers · documentação v1.3.4 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-gerencial-b2b/?format=markdown&indice=1).

## Dados

- [CEP / IBGE](https://webmania.com.br/docs/rest-api-cep-ibge/?format=markdown): API 2.0 · X-Token · documentação v2.0.1 (2026-11-09) · [índice de seções](https://webmania.com.br/docs/rest-api-cep-ibge/?format=markdown&indice=1).

## Changelog

- [Changelog (Markdown)](https://webmania.com.br/docs/changelog/): API and documentation changes, tracked separately.
- [Changelog (JSON)](https://webmania.com.br/docs/changelog/?format=json): structured public product history.
- [Changelog (RSS)](https://webmania.com.br/docs/changelog/feed/): subscribe to public product updates.

## SDKs Webmania

SDKs oficiais de código aberto, disponíveis no GitHub, para integrar as APIs Webmania na linguagem do seu projeto. Cada repositório traz a instalação, exemplos e as operações cobertas.

Instalação: clone o repositório (`git clone <repositório>.git`) e siga o README do SDK.

| SDK | Status | Plataformas | Repositório |
| --- | --- | --- | --- |
| Webmania SDK Node.js / TypeScript | Disponível | Node.js >= 22 | [webmaniabr/webmania-node](https://github.com/webmaniabr/webmania-node) |
| Webmania SDK Python | Disponível | Python >= 3.11 | [webmaniabr/webmania-python](https://github.com/webmaniabr/webmania-python) |
| Webmania SDK PHP | Disponível | PHP >= 8.3 | [webmaniabr/webmania-php](https://github.com/webmaniabr/webmania-php) |
| Webmania SDK Perl | Disponível | Perl 5.36 | [webmaniabr/webmania-perl](https://github.com/webmaniabr/webmania-perl) |
| Webmania SDK Go | Disponível | Go 1.26 | [webmaniabr/webmania-go](https://github.com/webmaniabr/webmania-go) |
| Webmania SDK C | Disponível | C11, Linux arm64 | [webmaniabr/webmania-c](https://github.com/webmaniabr/webmania-c) |
| Webmania SDK C++ | Disponível | C++, Linux arm64 | [webmaniabr/webmania-cpp](https://github.com/webmaniabr/webmania-cpp) |
| Webmania SDK Lua | Disponível | Lua 5.4, Linux arm64 | [webmaniabr/webmania-lua](https://github.com/webmaniabr/webmania-lua) |
| Webmania SDK Dart | Disponível | Dart >= 3.8.3, Linux arm64 | [webmaniabr/webmania-dart](https://github.com/webmaniabr/webmania-dart) |
| Webmania SDK R | Disponível | R >= 4.6.2, Linux arm64 | [webmaniabr/webmania-r](https://github.com/webmaniabr/webmania-r) |
| Webmania SDK Java | Disponível | Java 17+ | [webmaniabr/webmania-java](https://github.com/webmaniabr/webmania-java) |
| Webmania SDK Kotlin | Disponível | Kotlin 2.4 / JVM 17+ | [webmaniabr/webmania-kotlin](https://github.com/webmaniabr/webmania-kotlin) |
| Webmania SDK Scala | Disponível | Scala 3.3 / JVM 17+ | [webmaniabr/webmania-scala](https://github.com/webmaniabr/webmania-scala) |
| Webmania SDK Clojure | Disponível | Clojure 1.12 / JVM 17+ | [webmaniabr/webmania-clojure](https://github.com/webmaniabr/webmania-clojure) |
| Webmania SDK Ruby | Disponível | Ruby 3.3, Ruby 3.4 | [webmaniabr/webmania-ruby](https://github.com/webmaniabr/webmania-ruby) |
| Webmania SDK .NET (C#) | Disponível | .NET 10 | [webmaniabr/webmania-dotnet](https://github.com/webmaniabr/webmania-dotnet) |
| Webmania SDK PowerShell | Disponível | PowerShell 7.6 | [webmaniabr/webmania-powershell](https://github.com/webmaniabr/webmania-powershell) |
| Webmania SDK Elixir | Disponível | Elixir ~> 1.18, Linux arm64 | [webmaniabr/webmania-elixir](https://github.com/webmaniabr/webmania-elixir) |
| Webmania SDK Rust | Disponível | Rust >= 1.85 | [webmaniabr/webmania-rust](https://github.com/webmaniabr/webmania-rust) |
| Webmania SDK Haskell | Disponível | GHC 9.6.7, Linux arm64 | [webmaniabr/webmania-haskell](https://github.com/webmaniabr/webmania-haskell) |
| Webmania SDK Swift | Disponível | macOS 13+, iOS 16+ | [webmaniabr/webmania-swift](https://github.com/webmaniabr/webmania-swift) |

## Optional

- [NF-e API 1.0 OpenAPI](https://webmania.com.br/docs/rest-api-nfe/?format=openapi): scoped consultation and service checks; inspect `x-coverage`.
- [API 2.0 OpenAPI](https://api.webmania.com.br/docs/openapi): scoped consultation and NFS-e event contracts; inspect `x-coverage`. Full Markdown references remain necessary for issuance and provider-specific rules.