- Imprimir
- Modo NoturnoModo Claro
Integrações - Como trabalhar com a API do Octadesk
Para quais perfis: Administrador
A API do Octadesk permite fazer manipulações e consultas de informações do sistema por meio de JSON. Isso significa que é possível criar, editar e consultar.
Apenas a documentação da área de Tickets está disponível, que inclui os campos:
- Tickets;
- Pessoas;
- Organizações;
- Formulários;
- Ações Automáticas;
- Tags de tickets;
- Categorias de assuntos.
Obs: Ainda não temos integração API na parte de Chat/Conversas. Sem previsão até o momento.
Para isso, o primeiro passo é gerar um Access Token. O Access Token é a informação do usuário e suas permissões no formato JWT. Através dele é possível utilizar todas as outras funcionalidades e integrações das APIs.
Os endpoints utilizados são POST https://api.octadesk.services/login ou POST https://api.octadesk.services/login/apiToken
Eles se diferem na utilização:
- O POST https://api.octadesk.services/login utilizado em casos onde um único usuário fará todas as transações no sistema. Geralmente usuários administradores.
- O POST https://api.octadesk.services/login/apiToken não exige senha para se autenticar com o perfil de um usuário. É apropriado para a maioria dos casos, pois o cancelamento do API Token revoga o acesso de todos que o utilizam e a integração não fica sujeita às trocas de senhas.É recomendado também no caso de terceiros que estão desenvolvendo a integração com o seu ambiente Octadesk, pois eles não precisam ter ciência das credenciais de acesso somente o API Token.
Para utilização do primeiro endpoint, siga os passos abaixo para gerar o Access Token:
- Acesse a documentação da API em: https://api-docs.octadesk.services/docs/
- Na spec de Login, expanda a caixa POST /login;
- Clique em "Try it out";
- Informe um subDomain, usuário e senha válidos;
- Na área de "Response body", o token é todo o conteúdo entre as aspas após "token":
Para utilização do segundo endpoint, é necessário gerar um API Token no seu Octadesk. Para isso, siga os passos abaixo:
- No menu lateral acesse o menu de Tickets;
- Na seção Geral, clique na opção "Código de integração";
- Clique em Criar API Token;
- Dê um nome para seu Token e clique em “Criar API Token”;
- Clique em “copiar” e depois “salvar”.
Ambos endpoints geram a mesma estrutura de resultado.
Com o Access Token em mãos, você deve buscar o método da API conforme sua necessidade. Por exemplo, se você deseja incluir um novo ticket no sistema siga os passos abaixo:
- No canto direito superior, selecione a spec "Tickets";
- Como você deseja inserir o ticket, o método que deve ser utilizado é o POST /login
De forma resumida:
- Para inserir alguma informação (como criar um ticket, pessoa ou organização) o método é POST;
- Para editar alguma informação existe (como editar uma pessoa ou ticket) o método é PUT;
- Agora se você quer fazer uma consulta, o método indicado é o GET.
Note que os métodos PUT e GET exigem um parâmetro de localização como o número do ticket ou ID da pessoa para que eles façam a edição ou a consulta no local correto.
A requisição deve ser encaminhada para a URL apontada na spec desejada. Por exemplo, na imagem abaixo a URL para requisição é: https://api.octadesk.services/tickets/
Todas as chamadas seguintes deverão incluir na Headers a chave Authorization com o valor Bearer {access-token}, onde {access-token} deverá ser substituído. A figura abaixo exemplifica este preenchimento:
Caso você tenha dúvida dos parâmetros aceitáveis em cada variável, basta clicar em Model para verificar os requisitos de cada variável.
Então é isso! Se tiver dúvidas, não deixe de nos chamar. 😉
Nosso time atende diretamente pelo seu Octadesk em Ajuda > Suporte ou pelo nosso WhatsApp. 🐙✨