Source: https://ailoot.ai/docs/pt-pt/cabinet/profile/ Canonical: https://ailoot.ai/docs/pt-pt/cabinet/profile/ Language: pt-pt [API da área pessoal](https://ailoot.ai/docs/pt-pt/) # Perfil e segurança [Markdown](https://ailoot.ai/docs/pt-pt/cabinet/profile/index.md) Métodos, campos dos pedidos e respostas. Esta secção contém 6 métodos. Abra o método para consultar as condições de acesso, os campos do pedido e a resposta. | Método e caminho | Descrição | Acesso | | --- | --- | --- | | `PUT /api/v1/user` | Alteração do perfil | Token da área pessoal | | `GET /api/v1/user/passkeys` | Lista de passkeys | Token da área pessoal | | `PUT /api/v1/user/password` | Alteração da palavra-passe | Token da área pessoal | | `GET /api/v1/user/profile` | Perfil, saldo e associações | Token da área pessoal | | `GET /api/v1/user/totp/status` | Estado de 2FA (TOTP) | Token da área pessoal | | `GET /api/v1/user/totp/verification-method` | Método de verificação TOTP | Token da área pessoal | **PUT /api/v1/user** — Alteração do perfil Acesso: token da área pessoal PUT`/api/v1/user` ## Campos JSON / formulário | O campo | Tipo | Obrigatório | Validação / descrição | | --- | --- | --- | --- | | `username` | `string` | não | ; pode ser null | | `avatar_url` | `string` | não | ; pode ser null | | `balance_notify_enabled` | `boolean` | não | ; pode ser null | | `balance_notify_threshold` | `number` | não | ; pode ser null | Modelo do corpo do pedido ```json { "username": "PLACEHOLDER_USERNAME (string)", "avatar_url": "PLACEHOLDER_AVATAR_URL (string)", "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)", "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)" } ``` PLACEHOLDER representa os seus dados de entrada e o respetivo tipo. Substitua os valores e mantenha apenas os campos opcionais necessários; não envie marcadores de texto no lugar de números, booleanos, objetos ou arrays. Esquema do pedido: `UpdateProfileRequest` ## Resposta A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo. Esquemas de dados da resposta: `User`, `UserProfileResponse`. Os campos e os tipos estão nas páginas «Esquemas de dados». Esquema da resposta, com valores ilustrativos ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "email": "PLACEHOLDER_EMAIL (string)", "username": "PLACEHOLDER_USERNAME (string)", "role": "PLACEHOLDER_ROLE (string)", "balance": "PLACEHOLDER_BALANCE (number)", "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)", "concurrency": "PLACEHOLDER_CONCURRENCY (integer)", "status": "PLACEHOLDER_STATUS (string)", "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "deleted_at": "PLACEHOLDER_DELETED_AT (string)", "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)", "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)", "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)", "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)", "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)", "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)", "api_keys": "PLACEHOLDER_API_KEYS (array)", "avatar_url": "PLACEHOLDER_AVATAR_URL (string)", "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)" } } ``` Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT. Particularidades: a operação altera o estado ou prossegue uma autorização de utilização única; o exemplo descreve o contrato e não é executado. Particularidades: os limites de despesas das chaves (quota, quota\_used) são apresentados na resposta das chaves, e não no perfil. frozen\_balance é o valor reservado e não pode ser considerado saldo disponível. O método altera dados. Reenviar só é seguro quando o método indica Idempotency-Key. Se a resposta se perder, verifique primeiro o resultado (por exemplo, a lista de chaves) e só depois decida se deve repetir o pedido. **GET /api/v1/user/passkeys** — Lista de passkeys Acesso: token da área pessoal GET`/api/v1/user/passkeys` Leitura; o ID é obtido da sua resposta anterior ```bash curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \ -H "Authorization: Bearer $TOKEN" ``` Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL. ## Resposta A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo. Esquemas de dados da resposta: `PasskeyCredentialSummary`. Os campos e os tipos estão nas páginas «Esquemas de dados». Esquema da resposta, com valores ilustrativos ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "name": "PLACEHOLDER_NAME (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "backup": "PLACEHOLDER_BACKUP (boolean)" } } ``` Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT. Particularidades: credential é obtido de navigator.credentials; session\_token vem de begin. Corpo de finish \<=65536 bytes; o registo e a eliminação exigem palavra-passe. **PUT /api/v1/user/password** — Alteração da palavra-passe Acesso: token da área pessoal PUT`/api/v1/user/password` ## Campos JSON / formulário | O campo | Tipo | Obrigatório | Validação / descrição | | --- | --- | --- | --- | | `old_password` | `string` | sim | required | | `new_password` | `string` | sim | required,min=6 | Modelo do corpo do pedido ```json { "old_password": "PLACEHOLDER_OLD_PASSWORD (string)", "new_password": "PLACEHOLDER_NEW_PASSWORD (string)" } ``` PLACEHOLDER representa os seus dados de entrada e o respetivo tipo. Substitua os valores e mantenha apenas os campos opcionais necessários; não envie marcadores de texto no lugar de números, booleanos, objetos ou arrays. Esquema do pedido: `ChangePasswordRequest` ## Resposta A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo. Esquema da resposta, com valores ilustrativos ```json { "code": 0, "message": "success", "data": { "message": "VALUE_FROM_RESPONSE" } } ``` Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT. Particularidades: a operação altera o estado ou prossegue uma autorização de utilização única; o exemplo descreve o contrato e não é executado. O método altera dados. Reenviar só é seguro quando o método indica Idempotency-Key. Se a resposta se perder, verifique primeiro o resultado (por exemplo, a lista de chaves) e só depois decida se deve repetir o pedido. **GET /api/v1/user/profile** — Perfil, saldo e associações Acesso: token da área pessoal GET`/api/v1/user/profile` Leitura; o ID é obtido da sua resposta anterior ```bash curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \ -H "Authorization: Bearer $TOKEN" ``` Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL. ## Resposta A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo. Esquemas de dados da resposta: `User`, `UserProfileResponse`. Os campos e os tipos estão nas páginas «Esquemas de dados». Esquema da resposta, com valores ilustrativos ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "email": "PLACEHOLDER_EMAIL (string)", "username": "PLACEHOLDER_USERNAME (string)", "role": "PLACEHOLDER_ROLE (string)", "balance": "PLACEHOLDER_BALANCE (number)", "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)", "concurrency": "PLACEHOLDER_CONCURRENCY (integer)", "status": "PLACEHOLDER_STATUS (string)", "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "deleted_at": "PLACEHOLDER_DELETED_AT (string)", "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)", "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)", "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)", "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)", "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)", "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)", "api_keys": "PLACEHOLDER_API_KEYS (array)", "avatar_url": "PLACEHOLDER_AVATAR_URL (string)", "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)" } } ``` Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT. Particularidades: os limites de despesas das chaves (quota, quota\_used) são apresentados na resposta das chaves, e não no perfil. frozen\_balance é o valor reservado e não pode ser considerado saldo disponível. **GET /api/v1/user/totp/status** — Estado de 2FA (TOTP) Acesso: token da área pessoal GET`/api/v1/user/totp/status` Leitura; o ID é obtido da sua resposta anterior ```bash curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \ -H "Authorization: Bearer $TOKEN" ``` Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL. ## Resposta A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo. Esquemas de dados da resposta: `TotpStatusResponse`. Os campos e os tipos estão nas páginas «Esquemas de dados». Esquema da resposta, com valores ilustrativos ```json { "code": 0, "message": "success", "data": { "enabled": "PLACEHOLDER_ENABLED (boolean)", "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)", "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)" } } ``` Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT. Particularidades: secret e setup\_token são secretos; a verificação depende das definições de TOTP e do utilizador. **GET /api/v1/user/totp/verification-method** — Método de verificação TOTP Acesso: token da área pessoal GET`/api/v1/user/totp/verification-method` Leitura; o ID é obtido da sua resposta anterior ```bash curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \ -H "Authorization: Bearer $TOKEN" ``` Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL. ## Resposta A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo. Esquema da resposta, com valores ilustrativos ```json { "code": 0, "message": "success", "data": { "method": "email" } } ``` Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT. Particularidades: secret e setup\_token são secretos; a verificação depende das definições de TOTP e do utilizador. ## TotpVerificationMethod ```json { "type": "object", "required": [ "method" ], "properties": { "method": { "type": "string", "enum": [ "email", "password" ] } } } ``` Ainda tem dúvidas? Envie o Request ID e uma descrição — ajudamos a esclarecer.[Contactar o suporte](mailto:support@ailoot.ai) ## Ailoot · A empresa e a sua carteira de projetos A Ailoot assenta numa experiência operacional consolidada, numa ampla base de clientes, num serviço estável e no acompanhamento contínuo dos KPI. A empresa e a sua carteira de projetos: milhões de clientes; vendas mensais na ordem dos milhares de milhões. A Ailoot aplica essa experiência operacional ao acesso por API a funcionalidades de IA nos produtos dos clientes, agentes, aplicações e automatizações.