Skip to main content
Esta é a documentação da API da Olie. Aqui você encontra como autenticar as requisições, como ler as respostas e a referência de cada endpoint, para integrar a Olie com outros sistemas.

Como a API funciona

A API oferece as mesmas funções que as interfaces da Olie usam. Todas as requisições usam HTTPS e o domínio api.olie.ai. Parte dos recursos segue o padrão REST, como GET /api/management/projects para listar projetos. Outros usam um endpoint POST com o nome da ação no caminho, como POST /api/management/get-form. A referência de cada endpoint mostra o método e o caminho exatos.

Testar com o Postman

Você pode explorar e testar a API no Postman. A coleção oficial da Olie no Postman traz os endpoints documentados aqui e é atualizada com frequência. Use a coleção para fazer requisições reais e ver a estrutura de cada endpoint.

Próximos passos

Comece pela autenticação e depois veja como a API responde:

Autenticação e segurança

Como obter o token de acesso e usá-lo nas requisições.

Detalhes

URL base, formato das respostas e limite de requisições.

Estrutura de resposta

Como ler as respostas de sucesso e de erro.

Paginação

Como percorrer listagens com muitos itens.