Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Crie contas de agentes, liste usuários com paginação, consulte status online/offline e atualize dados de usuário via API externa do PanÐá Zap.
Authorization: Bearer {BearerToken}.
POST https://{BaseUrl}/v2/api/external/{ApiID}/createUser
{
"email": "usuario@example.com",
"password": "senha123",
"name": "Nome do Usuário",
"profile": "user"
}
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | Sim | Endereço de e-mail de login. Deve ser único dentro do tenant. |
password | string | Sim | Senha inicial da conta (mínimo 8 caracteres). Recomenda-se pedir ao usuário para alterá-la no primeiro acesso. |
name | string | Sim | Nome completo exibido na plataforma. |
profile | string | Sim | Papel do usuário — admin ou user. |
GET https://{BaseUrl}/v2/api/external/{ApiID}/listUsers?pageNumber=1
| Query param | Tipo | Obrigatório | Descrição |
|---|---|---|---|
pageNumber | integer | Não | Número da página a retornar (padrão: 1). |
searchParam | string | Não | Busca por texto livre em nome ou e-mail. |
GET https://{BaseUrl}/v2/api/external/{ApiID}/getUserStatus?userId=1
| Query param | Tipo | Obrigatório | Descrição |
|---|---|---|---|
userId | integer | Sim | ID do usuário a consultar. |
POST https://{BaseUrl}/v2/api/external/{ApiID}/updateUser
{
"userId": 1,
"name": "Nome Atualizado",
"email": "novoemail@example.com"
}
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
userId | integer | Sim | ID do usuário a atualizar. |
name | string | Não | Novo nome de exibição. |
email | string | Não | Novo endereço de e-mail. |
{
"success": true,
"data": { ... }
}
createUser, data traz os detalhes do usuário criado. Em listUsers, data traz o array paginado de usuários.