​

APIs da Plataforma AirysChat

As APIs da Plataforma AirysChat permitem que você integre uma interface de gerenciamento de conversas em sua pilha de software existente. Os administradores de instalação podem usar essas APIs para gerenciar usuários, contas e funções. Além disso, essas APIs podem ser usadas para sincronizar informações de autenticação de sistemas externos para o AirysChat.

Nota: Essas APIs estão disponíveis apenas em instalações self-hosted do AirysChat.

​

Criando um Aplicativo de Plataforma

Para criar um aplicativo de plataforma, siga estas etapas:

1. Acesse o portal do super administrador e navegue até super_admin/platform_apps.
2. Clique no botão “New platform app” (Novo aplicativo de plataforma).
3. Preencha o nome do aplicativo de plataforma e clique no botão “Create” (Criar).
4. Após criar o aplicativo de plataforma, abra-o para visualizar e copiar o token de acesso.

​

Usando o Token de Acesso

O access_token é necessário para autenticar todas as solicitações de API. Por favor, use a coleção do Postman para testar essas APIs.

​

Testando as APIs

Para testar as APIs:

1. Copie o token de acesso do aplicativo de plataforma.
2. Use-o no cabeçalho Authorization das suas solicitações de API.

Aqui está um exemplo de como criar um usuário usando a API: Da mesma forma, você pode criar entidades Account (Conta) e Role (Função) usando as APIs.

​

Referência

Para informações mais detalhadas e para testar as APIs, consulte nossa Coleção do Postman.