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

# Introdução

> Integre as ações da sua conta Sortify a qualquer sistema

A API pública da Sortify permite integrar suas ações (sorteios) a sistemas externos: consulte as ações ativas da sua conta, acompanhe o progresso de vendas em tempo real e construa automações em cima da plataforma.

## Base URL

Todas as requisições usam a seguinte base:

```text theme={null}
https://api.sortify.com.br
```

## Comece em 3 passos

<Steps>
  <Step title="Crie uma credencial">
    No [painel da Sortify](https://app.sortify.com.br), crie uma credencial de API. Você recebe um par de tokens: público (`pb_...`) e secreto (`sk_...`).
  </Step>

  <Step title="Guarde o token secreto">
    O token secreto é exibido **apenas uma vez**. Armazene-o em um gerenciador de segredos — ele não pode ser recuperado depois.
  </Step>

  <Step title="Faça sua primeira requisição">
    ```bash theme={null}
    curl -u "pb_SEU_TOKEN_PUBLICO:sk_SEU_TOKEN_SECRETO" \
      "https://api.sortify.com.br/v1/raffles"
    ```
  </Step>
</Steps>

## Explore a API

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/autenticacao">
    Como funciona o par de tokens e o HTTP Basic Auth
  </Card>

  <Card title="Listar ações" icon="list" href="/api-reference/acoes/listar-acoes">
    Todas as ações ativas e em andamento da sua conta
  </Card>

  <Card title="Obter ação" icon="ticket" href="/api-reference/acoes/obter-acao">
    Detalhes completos de uma ação, com imagens e progresso de vendas
  </Card>

  <Card title="Painel Sortify" icon="gauge" href="https://app.sortify.com.br">
    Crie e gerencie suas credenciais de API
  </Card>
</CardGroup>

## Formato das respostas

Todas as respostas são JSON com o envelope padrão:

<CodeGroup>
  ```json Sucesso theme={null}
  {
    "success": true,
    "message": "Ações listadas com sucesso",
    "data": {}
  }
  ```

  ```json Erro theme={null}
  {
    "success": false,
    "error": {
      "message": "Credenciais de API inválidas",
      "code": "INVALID_API_CREDENTIALS"
    }
  }
  ```
</CodeGroup>

* `message`: texto em português, adequado para exibição ao usuário final.
* `code`: código estável em inglês, adequado para tratamento programático.

## Convenções

* **Valores monetários são sempre inteiros em centavos** (ex.: `ticket_price: 199` = R\$ 1,99). Divida por 100 para exibir em reais.
* **Datas** são strings ISO 8601 em UTC (sufixo `Z`).
* **IDs** são UUIDs.

## Limites de requisição

Cada credencial pode realizar até **120 requisições por minuto**. Ao exceder o limite, a API responde com HTTP `429` e o código `RATE_LIMIT_EXCEEDED`.

<Tip>
  As respostas de listagem são atualizadas a cada 15 segundos. Não há necessidade de consultar a API em intervalos menores que esse.
</Tip>