Uma API (Application Programming Interface) é uma solução que facilita a integração entre sistemas. Com o conjunto de normas e padrões disponibilizados por uma interface de aplicação, é possível conectar plataformas para acessar e gerenciar dados variados com mais facilidade e segurança.
Em termos gerais, uma requisição feita por um usuário em uma determinada API vai desencadear um processamento de informações, que serão retornadas de forma rápida e objetiva e apresentadas de acordo com o objetivo da solicitação realizada.
Com a API Arquivei, é possível integrar a gestão de documentos fiscais com ERPs ou sistemas internos para otimizar ainda mais a rotina de empresas e escritórios contábeis. Leia neste artigo as principais etapas para utilizar as nossas interfaces.
🔵 O que é preciso para utilizar a API Arquivei?
No momento, nossa API pode ser utilizada por clientes que desejam automatizar fluxos integrados para ERPs ou sistemas internos.
Se você tem interesse em fazer uma integração com o Arquivei via API, tenha em mente que o desenvolvimento para a solução funcionar é de responsabilidade do cliente que contratar este serviço. Por isso, é importante validar antes com o time de TI da sua empresa ou escritório as estruturas necessárias para implementar a integração.
🔵 Quais endpoints estão disponíveis na API Arquivei?
*Para NFSes, estão disponíveis ainda endpoints de OCR (Optical Character Recognization - Reconhecimento Ótico de Caracteres).
🔵 Como funciona a API Arquivei?
A interface do Arquivei utiliza o padrão REST, que viabiliza uma integração eficiente a qualquer linguagem de programação.
De forma resumida, a API possui endpoints específicos onde será possível se conectar e obter um retorno. A integração com a API pode ser mais simples ou mais complexa, a depender das suas necessidades de gestão fiscal.
👀 Quero desenvolver, e agora?
O passo inicial é ler a documentação da API Arquivei, que reúne todos os padrões necessários para começar a desenvolver uma aplicação própria.
Além disso, é importante saber:
A API Arquivei não busca o histórico de notas. Assim, ficarão disponíveis os documentos fiscais consultados ou importados a partir da liberação no ambiente de produção;
Como indicado anteriormente, a API Arquivei disponibiliza no momento os XMLs e PDFs de documentos fiscais, sendo que:
Em formato XML, estão à disposição endpoints para download de NFe, CTe, CTe-OS e NFSe;
Em PDF, os endpoints para download são de DANFe, DACTe e DACTe-OS;
Além disso, é possível também realizar o envio de XMLs e manifestações de NFes em lote e o envio de NFSes através do processo de OCR (Optical Character Recognization - Reconhecimento Ótico de Caracteres), realizado através de uma parceria;
Todos os endpoints podem ser conferidos em nossa documentação;
Caso novos CNPJs sejam adicionados na plataforma Arquivei, a liberação para a API será feita de forma manual pelo nosso time.
❓ Dúvidas frequentes sobre API Arquivei
Existe uma precificação diferenciada para API Arquivei?
Sim. O serviço da API Arquivei poderá ser utilizado conforme uma precificação específica. Caso você queira solicitar um orçamento, entre em contato conosco pelo suporte@arquivei.com.br ou pelo chat.
É possível realizar testes na API?
Sim. Em nossa documentação, você encontra o caminho para o ambiente de teste Sandbox. Ele é composto por credenciais de acesso e notas com dados fictícios, sem validade jurídica, que refletem toda a estrutura da API Arquivei em produção. Este ambiente é ideal para uma primeira implementação e para validar a integração, as respostas da API e o tratamento dos dados, por exemplo.
Caso você precise validar como a API Arquivei se encaixa em seus processos de gestão e exista a necessidade de utilizar notas reais, recebidas pelas empresas que você gerencia, entre em contato com o nosso time de especialistas para encontrarmos a solução mais efetiva para o seu negócio.
É possível integrar o Arquivei via API com todos os ERPs e sistemas?
A utilização do padrão REST pela API Arquivei facilita a integração com diversos ERPs. Dependendo do sistema utilizado na sua empresa ou escritório, será necessário realizar parte do desenvolvimento de integração pela sua própria equipe de TI.
Para alguns dos ERPs mais conhecidos no mercado, a Arquivei tem parceiros que podem ajudar você e a sua equipe a implementar a solução.
Quanto tempo, em média, eu preciso para ter uma integração funcionando com uma API?
O tempo de integração varia de acordo com a velocidade com que seu time de desenvolvimento consegue implementar a integração. Como a API Arquivei é baseada no padrão REST, o mais utilizado para integrações no mercado, o processo costuma ser mais rápido.
Mas, é claro: analisar como a API se encaixa em sua rotina de trabalho e entender como a solução impacta no seu dia a dia é uma parte importante da implementação.
Temos uma equipe preparada para fornecer todo o suporte necessário e te ajudar a mapear necessidades e caminhos de otimização dos processos fiscais. Se quiser saber mais, entre em contato com o nosso time de Experiência do Cliente pelo chat do Arquivei.
Como funciona o gerenciamento de usuários dentro da API?
Não temos a disponibilização de usuários para a API Arquivei.
Ao iniciar o uso da interface, serão informados pelo nosso time um ID e uma chave secreta para realizar a autenticação em nosso sistema. Estes dados serão utilizados para autenticar todas as requisições feitas na API, concedendo acesso a todos os documentos disponíveis para a sua conta a partir da contratação.
A API Arquivei pode ser disponibilizada para terceiros?
Sim. É possível fornecer acesso à API Arquivei sem precisar compartilhar o ID ou a chave secreta que serão gerados para a sua conta.
Através da criação de uma chave de permissão, é possível que um parceiro integre à nossa API utilizando credenciais de acesso próprias e assim faça buscas, downloads e outros usos das notas disponíveis para as empresas que você cuida.
Existe um limite de requisições na API?
O limite de requisições para a API Arquivei é definido para cada cliente, de acordo com a necessidade do negócio e com o volume de documentos fiscais gerenciados.
Qual é o canal de suporte para a API Arquivei?
Utilize sempre o e-mail suporte@arquivei.com.br ou o chat da plataforma para conversar com o nosso time sobre API Arquivei. Estamos à disposição para te ajudar 🤗
Quer conhecer outra forma de integrar o Arquivei com seu ERP ou sistema interno? Saiba mais sobre o módulo Sincroniza Notas®:
💡 Precisa de uma solução personalizada para a sua empresa ou escritório? Chame nossa equipe agora mesmo pelo chat para entendermos a sua demanda.