Source: https://ailoot.ai/docs/pt-pt/cabinet/redeem/
Canonical: https://ailoot.ai/docs/pt-pt/cabinet/redeem/
Language: pt-pt

[API da área pessoal](https://ailoot.ai/docs/pt-pt/) 

# Códigos de carregamento

[Markdown](https://ailoot.ai/docs/pt-pt/cabinet/redeem/index.md)

Métodos, campos dos pedidos e respostas.

Esta secção contém 2 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 |
| --- | --- | --- |
| `POST /api/v1/redeem` | Resgate de um código | Token da área pessoal |
| `GET /api/v1/redeem/history` | Histórico de resgates | Token da área pessoal |

**POST /api/v1/redeem** — Resgate de um código

Acesso: token da área pessoal

POST`/api/v1/redeem`

## Campos JSON / formulário

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `code` | `string` | sim | required |

Modelo do corpo do pedido

```json
{
  "code": "PLACEHOLDER_CODE (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: `RedeemRequest`

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquemas de dados da resposta: `RedeemCode`. 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)",
    "code": "PLACEHOLDER_CODE (string)",
    "type": "PLACEHOLDER_TYPE (string)",
    "value": "PLACEHOLDER_VALUE (number)",
    "status": "PLACEHOLDER_STATUS (string)",
    "used_by": "PLACEHOLDER_USED_BY (integer)",
    "used_at": "PLACEHOLDER_USED_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
    "notes": "PLACEHOLDER_NOTES (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}
```

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/redeem/history** — Histórico de resgates

Acesso: token da área pessoal

GET`/api/v1/redeem/history`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `page` | `integer` | não | ; por predefinição: 1; positive integer |
| `page_size` | `integer` | não | ; por predefinição: 20; positive; clamp to100 |

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: `RedeemCode`. 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": {
    "items": [
      {
        "id": "PLACEHOLDER_ID (integer)",
        "code": "PLACEHOLDER_CODE (string)",
        "type": "PLACEHOLDER_TYPE (string)",
        "value": "PLACEHOLDER_VALUE (number)",
        "status": "PLACEHOLDER_STATUS (string)",
        "used_by": "PLACEHOLDER_USED_BY (integer)",
        "used_at": "PLACEHOLDER_USED_AT (string)",
        "created_at": "PLACEHOLDER_CREATED_AT (string)",
        "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
        "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
        "notes": "PLACEHOLDER_NOTES (string)",
        "user": "PLACEHOLDER_USER (object)"
      }
    ],
    "total": "PLACEHOLDER_TOTAL (integer)",
    "page": "PLACEHOLDER_PAGE (integer)",
    "page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
    "pages": "PLACEHOLDER_PAGES (integer)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

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.