Portal – Como acessar a API de dados

O Portal disponibiliza algumas API’s que permitem acessar informações diretamente do banco de dados para a criação de relatórios externos. Para que a comunicação funcione, a API utiliza duas chaves: a chave da unidade e a chave do usuário. Caso qualquer uma dessas chaves seja inativada ou excluída, o acesso será interrompido e será necessário solicitar novas chaves.

Se for a primeira vez que a unidade utilizar a API, é preciso entrar em contato com a equipe de suporte para a geração dessas chaves. Caso você já tenha acesso e queira utilizar outra API, basta que seu usuário possua permissão para acessar o cadastro de usuários.

Se a unidade desejar habilitar uma nova API, também é necessário abrir um chamado com o suporte para análise.

Importante ressaltar que, embora as API’s estejam disponíveis, não contamos com uma equipe dedicada para auxiliar na criação de integrações. Por isso, recomendamos que o time de T.I. da unidade ofereça esse suporte, preferencialmente alguém familiarizado com as ferramentas utilizadas pela empresa.

Acesse cadastro de usuários

Acesse o sistema através do link https://codex.ambito.com.br

 

Nesse primeiro passo, você deverá acessar “Pessoas/Usuários” da unidade desejada.

Editar usuário

Localize e acesse o cadastro do seu usuário para poder pegar as chaves.

 

 

OBS: As permissões desse usuário não interferem no que pode ser visualizado pela API.

Exibir dados da API

Ao acessar o cadastro do usuário, clique em “Exibir credencias da API”

Copie as chaves

A chave “ApiKey” se refere a x-api-key, já a chave “UserToken” se refere a x-ambito-key.

Acesse os links

Os sistemas terão acesso às API’s por meio de links específicos, que podem ser organizados por sistema e por funcionalidades — como, por exemplo, obrigações e planos de ação do Legal.

Para acessá-las, na mesma tela de cadastro do usuário, logo abaixo das chaves, clique em “Clique aqui para Acessar Repositório API”.

 

Você será redirecionado para outro site com nossos links disponíveis no momento.

Link das documentações

Encontre o sistema desejado, nesse caso, vamos usar a planilha de obrigações do Legal, a getworksheetoccurrences.

 

 

Encontrando o link, em um bloco de nota ou espaço para texto, copie e cole o início, que é https://api.ambito.com.br.

Após isso, copie clicando no ícone indicado no print abaixo:

 

 

Cole essa segunda parte em sequência do link, formando o link de acesso completo.

 

Acesse a API

Com as informações coletadas anteriormente, link e chave, utilize-as para acessar os dados a partir do seu sistema. No print abaixo, utilizamos o Power BI.

Finalização

Após configurar o acesso e validar o retorno das informações, seu sistema estará pronto para consumir os dados disponibilizados pela API, permitindo a criação de relatórios, integrações e análises conforme a necessidade da sua operação.

Esse artigo foi útil?