> ## Documentation Index
> Fetch the complete documentation index at: https://docs.airys.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# APIs da Plataforma AirysChat

# 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`.

   <img src="https://mintcdn.com/airys/1FWn-RJM-8Ky_sbQ/contributing-guide/images/platform-app/super_admin.png?fit=max&auto=format&n=1FWn-RJM-8Ky_sbQ&q=85&s=8559ac591652fc9e00aae177625ddb62" alt="Portal do Super Administrador" width="2920" height="2316" data-path="contributing-guide/images/platform-app/super_admin.png" />

2. Clique no botão "New platform app" (Novo aplicativo de plataforma).

   <img src="https://mintcdn.com/airys/1FWn-RJM-8Ky_sbQ/contributing-guide/images/platform-app/platform-home.png?fit=max&auto=format&n=1FWn-RJM-8Ky_sbQ&q=85&s=73c279959bcaea56524f64e7b47dcbee" alt="Página Inicial dos Aplicativos de Plataforma" width="2924" height="2330" data-path="contributing-guide/images/platform-app/platform-home.png" />

3. Preencha o nome do aplicativo de plataforma e clique no botão "Create" (Criar).

   <img src="https://mintcdn.com/airys/1FWn-RJM-8Ky_sbQ/contributing-guide/images/platform-app/platform-create.png?fit=max&auto=format&n=1FWn-RJM-8Ky_sbQ&q=85&s=55f7593b3ca8276075fcfe7f7b68ee36" alt="Criar Aplicativo de Plataforma" width="2918" height="2324" data-path="contributing-guide/images/platform-app/platform-create.png" />

4. Após criar o aplicativo de plataforma, abra-o para visualizar e copiar o token de acesso.

   <img src="https://mintcdn.com/airys/1FWn-RJM-8Ky_sbQ/contributing-guide/images/platform-app/platform-access-token.png?fit=max&auto=format&n=1FWn-RJM-8Ky_sbQ&q=85&s=198d156e2f276a3d0d8e50ae98166550" alt="Token de Acesso do Aplicativo de Plataforma" width="2922" height="2328" data-path="contributing-guide/images/platform-app/platform-access-token.png" />

## 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:

<img src="https://mintcdn.com/airys/1FWn-RJM-8Ky_sbQ/contributing-guide/images/platform-app/create-user.png?fit=max&auto=format&n=1FWn-RJM-8Ky_sbQ&q=85&s=24323e2309238992cc850f74cee7fa03" alt="API de Criar Usuário" width="2794" height="2144" data-path="contributing-guide/images/platform-app/create-user.png" />

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](https://www.postman.com/airyschat/workspace/airyschat-apis/collection/162770-e5451b69-9f97-489b-b352-4ca7d8d82aff).