Skip to main content
Toda requisição à API precisa de um token de acesso. Esta página mostra como enviar o token, como obtê-lo criando uma aplicação na Olie e o que saber sobre validade, troca e permissões do token.

Enviar o token na requisição

A API identifica quem faz a chamada pelo token de acesso de uma aplicação, a credencial de integração da Olie. Envie o token no cabeçalho Authorization, com o prefixo Bearer antes dele:
cURL
O prefixo Bearer é obrigatório. Sem ele, a API trata a requisição como não autenticada e responde com HTTP 401.
Mantenha o token em segurança. Nunca compartilhe o token nem o coloque em repositórios públicos.

Obter o token de acesso

O token é gerado quando você cria uma aplicação nos ajustes da empresa.
1

Abra Aplicações

Entre na sua empresa em https://olie.ai/frames e vá em Ajustes > Integrações > API, na aba Aplicações.
Menu lateral de Ajustes com os itens Papéis e Ajustes da empresa e, abaixo, o grupo Integrações com Aplicações contornado, seguido de Webhooks, MCP e Integrações

Aplicações fica no grupo Integrações do menu de Ajustes

2

Crie uma aplicação

Clique em Criar aplicação e preencha os campos obrigatórios. A plataforma mostra o token de acesso gerado.
Guarde o token em um local seguro. A plataforma não mostra o token de novo.
3

Use o token

Envie o token no cabeçalho Authorization das requisições, como em Enviar o token na requisição.
Se a requisição responder com HTTP 200 e "response": true, o token está funcionando.

Ciclo de vida do token

O token nasce junto com a aplicação e não muda mais. Planeje a integração considerando as características abaixo. Se você perder o token, não há como recuperá-lo. Crie outra aplicação e use o token novo.

Trocar um token

Como não há rotação, você troca o token substituindo a aplicação:
1

Crie uma nova aplicação

Guarde o novo token com segurança.
2

Aponte a integração para o novo token

Faça a virada no seu lado e confirme que as chamadas continuam funcionando.
3

Exclua a aplicação antiga

Exclua a aplicação em Ajustes > Integrações > API, na aba Aplicações, com um usuário que tenha a permissão applications.create. A exclusão revoga apenas o token daquela aplicação. As demais aplicações da empresa seguem funcionando normalmente.O endpoint DELETE /api/management/applications/{id} é reservado a pessoas. Uma chamada feita com token de aplicação recebe HTTP 403 com message: "access_denied_for_applications".
Como não há limite de aplicações, você pode manter a antiga e a nova ativas durante a virada. Exclua a antiga só depois de confirmar que ninguém mais a usa.

Expiração

O token expira 1 ano depois de criado, sem aviso prévio. A partir daí, as requisições com esse token respondem com HTTP 401. Registre a data de criação do lado da integração e troque o token antes do vencimento.

Segurança e permissões

Uma aplicação tem acesso total dentro da empresa a que pertence. Não existe escopo por permissão: não é possível criar uma aplicação que só leia projetos, ou que não enxergue clientes.
O token de uma aplicação equivale a um acesso privilegiado à empresa inteira. Trate-o como uma credencial de administrador: nunca o exponha em repositórios, front-ends ou logs.
O token tem dois limites:
  • Uma empresa só. O token enxerga apenas os dados da empresa em que a aplicação foi criada.
  • Nem todos os endpoints. Alguns endpoints são reservados a pessoas e recusam aplicações com HTTP 403 e message: "access_denied_for_applications".

Autoria no histórico

Tudo que a aplicação altera fica no registro de alterações com a própria aplicação como autora, e não com o usuário que criou a aplicação. Se você precisa distinguir o que cada integração fez, crie uma aplicação por integração.

Quando usar o MCP

O servidor MCP é outro caminho de acesso à Olie. Nele, a autenticação é feita por OAuth e como usuário, não como aplicação. As chamadas passam pelas permissões desse usuário, e o histórico registra o nome dele. O MCP também tem um limite de requisições próprio, separado do limite da API. Use o MCP quando o acesso deve refletir o que uma pessoa pode fazer, e a API com token de aplicação quando a integração é servidor-a-servidor. Veja MCP.

Erros de autenticação

Estas respostas indicam problema com o token ou com o acesso da aplicação: Exemplo de resposta 401:

Próximos passos

Com o token funcionando, veja como consultar e alterar dados pela API:

Filtros

Filtre e ordene as listagens pela URL.

Paginação

Como percorrer listagens com muitos itens.

Reenvio e duplicidade

O que acontece quando uma chamada dá timeout e você reenvia.

Operações em lote

Atualize ou mova vários registros em uma única requisição.