Como realizar a integração do Operand com outros sistemas via API Pública?

A API pública possibilita a integração do Operand com outros sistemas :)

Este recurso está disponível para o módulo financeiro, dessa forma, é possível realizar integrações com sistema de emissão de Nota Fiscal, emissão de Boletos, softwares de dashboard e BI e até mesmo sistemas próprios, desde que possuam integração via API.

O que é uma API?

Primeiro, é importante entender o que é uma API.

API: Application Programming Interface, ou traduzido para o português, Interface de Programação de Aplicativos, é um conjunto de rotinas e padrões de programação que permite conectar ou acessar aplicativos e plataformas. 

Na prática, a API é uma porta criada no Operand, que permite que outras aplicações acessem informações de dentro do sistema.

Como funciona a API Operand?

Nós disponibilizaremos um token e a documentação da API, para que o próprio cliente desenvolva a integração entre o Operand e a aplicação desejada.

Como ativar a API Operand e gerar o token?

O token gerado no Operand é a chave que permitirá que o sistema, que está recebendo a integração, tenha acesso às informações do Operand. Apenas o responsável da conta (root) e administradores possuem permissão para ativar a API e gerar essa chave.

Para isso, basta acessar o seu Avatar > Configurações > Módulos e funções > API Operand > Gerar token, dessa forma, o sistema irá gerar um token que estará pronto para ser utilizado.

Cada conta pode ter apenas um token ativo por vez, mas é possível gerar um novo token a qualquer momento clicando em gerar um novo token e depois em Confirmar.

Ao gerar um novo token, o anterior será substituído. Caso existam integrações ativas elas serão automaticamente inativadas e será necessário atualizar o código do token nessas integrações para ativá-las novamente.

Também é possível desativar o token se necessário, para isso clique em Desativar Token e depois em Confirmar.

Fazendo isso, o token será invalidado automaticamente. Se houver integrações ativas elas serão automaticamente inativadas e será necessário gerar um novo token e atualizar o código nessas integrações para ativá-las novamente.

Como acessar a documentação da API Pública Operand?

Na página da API Operand, onde foi gerado o token, está disponível a documentação. Nesta documentação estão descritos os métodos e as variáveis que permitirão desenvolver a integração com o sistema que desejar, realizando consultas dentro do Operand e enviando essas informações para o sistema integrado.

Quais os passos para realizar a integração?

O profissional técnico responsável pela integração deverá criar um ponto intermediário (módulo integrador) para realizar as conexões dos métodos descritos na documentação com os campos de entrada do sistema que será realizada a integração. Nesse momento serão utilizados o token gerado no Operand e a documentação da API.

Para realizar a integração será necessário seguir os passos:

1. Possuir conhecimento para realizar o procedimento (é recomendado que esse processo seja realizado por um profissional técnico devido a sua complexidade).
2. Definir em qual sistema será realizada a integração e verificar se essa aplicação oferece integração via API.
3. Ler a documentação da API Pública Operand e da API da aplicação que será realizada a integração.
4. Ativar a função API Operand e gerar o token.
5. Gerar o token na aplicação desejada (esse token é necessário para que o módulo integrador, que será desenvolvido, entregue as informações na aplicação desejada).
6. Desenvolver a integração para conectar o Operand à aplicação desejada.
7. Testar a integração.

Se estiver tudo certo, a integração estará pronta para uso! :)