Introdução
Por meio da API REST Oobj, os clientes Oobj podem gerenciar empresas cadastradas, emitir, receber e monitorar seus Documentos Fiscais Eletrônicos (DFes).
Fundamentada no padrão REST (Representational State Transfer), esta API possibilita a interação ágil e escalável com recursos distribuídos.
A seguir, você encontra informações sobre os principais recursos, particularidades da API Oobj, como ler esta documentação e próximos passos.
Principais recursos
A API REST Oobj é robusta e oferece uma variedade de recursos para o universo da Gestão Fiscal, incluindo:
Emissão e Recebimento de DFes
- Emissão de NFe, CTe, MDFe, NFCe, NFSe e NF3e;
- Emissão de documentos auxiliares, como DANFes;
- Emitir, importar e consultar eventos fiscais;
- Receber automaticamente NFes e CTes, por meio do Oobj MDe;
- Consultar NFe, CTe, CTe-OS, MDFe e NFCe recebidos.
Gerenciamento fiscal, configurações e integrações
- Consultar MDFes não encerradas;
- Consultar informações cadastrais de contribuintes diretamente na SEFAZ;
- Configurar contingência automática;
- Realizar inutilização de DFes;
- Realizar conciliação entre as vendas do seu ERP/PDV com os DFes emitidos com a Oobj;
- Realizar manutenções do Código do Contribuinte (CSC) das empresas que você gerencia;
- Gerar diversos tipos de relatórios.
Particularidades da API
- Todos os tipos de documentos são emitidos no mesmo endpoint, o Emitir DFe. Acesse o artigo Como emitir um DFe para entender melhor o funcionamento de emissões via API;
- Toda solicitação de emissão é feita de forma assíncrona;
- Para emissão de Nota Fiscal Eletrônica (NFe), você pode configurar um webhook no Monitor. Consulte o artigo Como configurar webhook no Monitor, na Base de conhecimento Oobj, para saber mais;
Layouts aceitos
Os layouts aceitos para cada tipo de documento são mostrados a seguir:
| | NFe | CTe | MDFe | NFCe | NFSe | NF3e |
|---|---|---|---|---|---|---|
| XML Oobj | ✔ | ✔ | ✔ | ✔ | ❌ | ✔ |
| XML Sefaz | ✔ | ✔ | ✔ | ✔ | ❌ | ✔ |
| XML Datasul | ✔ | ❌ | ❌ | ❌ | ✔ | ❌ |
| TXT-SP | ✔ | ❌ | ❌ | ✔ | ❌ | ❌ |
| TXT-ABRASF | ❌ | ❌ | ❌ | ❌ | ✔ | ❌ |
| JSON Oobj | ✔ | ✔ | ✔ | ✔ | ❌ | ❌ |
Caso o layout utilizado pela sua empresa seja diferente desses, entre em contato com seu gerente comercial. Dessa forma, a equipe poderá avaliar o caso com atenção 😉
Sobre a documentação
Esta documentação é dividida em duas seções, com possibilidades distintas:
- Na seção Documentação (que é onde você está agora), é possível acessar guias passo a passo. Neles são explicados os procedimentos, parâmetros e exemplos de requisição e retorno, bem como uma visão geral dos endpoints. Ideal para quem está tendo o primeiro contato com a API Oobj;
- Já a Referência de API contém um plugin do Swagger, onde você pode testar a API, fazendo requisições no ambiente de homologação. Esse plugin monta automaticamente as requisições em cURL, JavaScript, C#, php e Java.
Esta documentação possibilita testes no ambiente de homologação. Caso precise de acesso ao ambiente de produção, entre em contato com o suporte 😉
Próximos passos
Acesse o artigo Conceitos fundamentais para uma compreensão detalhada dos princípios essenciais por trás da API Oobj. Nesse artigo serão abordados tópicos como autenticação e autorização, rate limit, formato de troca de mensagens, códigos de status HTTP e boas práticas.
