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

# Chaves de API

> Crie, configure escopos e revogue suas chaves

As chaves de API são criadas e gerenciadas no painel, na seção **Desenvolvedores**. Cada chave pertence à sua conta e carrega um conjunto de escopos.

## Criar uma chave

<Steps>
  <Step title="Abra Desenvolvedores no painel">
    Acesse a seção Desenvolvedores e clique em **Nova chave de API**.
  </Step>

  <Step title="Dê um nome e escolha o modo">
    Use um nome que identifique o uso (por exemplo, "Integração ERP"). Escolha o modo `live` ou `test`.
  </Step>

  <Step title="Selecione os escopos">
    Marque apenas os escopos que a integração precisa.
  </Step>

  <Step title="Copie o segredo">
    O segredo é exibido **uma única vez**. Copie e guarde com segurança. Se perder, gere uma nova chave.
  </Step>
</Steps>

## Escopos

Cada escopo libera um conjunto de operações. Conceda o mínimo necessário.

| Escopo               | Permite                                              |
| -------------------- | ---------------------------------------------------- |
| `products:read`      | Consultar e listar produtos                          |
| `products:write`     | Criar, editar, arquivar e alterar preços de produtos |
| `orders:read`        | Consultar e listar pedidos                           |
| `checkouts:read`     | Consultar e listar checkouts                         |
| `checkouts:write`    | Editar checkouts                                     |
| `upsells:read`       | Consultar e listar upsells                           |
| `upsells:write`      | Criar, editar e excluir upsells                      |
| `sales:read`         | Consultar o resumo de vendas                         |
| `dashboards:read`    | Consultar métricas                                   |
| `subscriptions:read` | Consultar e listar assinaturas                       |

Uma chamada para um endpoint cujo escopo a chave não possui retorna `403`:

```json theme={null}
{
  "error": {
    "type": "insufficient_scope",
    "message": "This API key is missing the required scope."
  }
}
```

## Revogar uma chave

Na seção Desenvolvedores, revogue a chave a qualquer momento. A revogação é imediata: a partir dela, qualquer chamada com aquela chave passa a retornar `401`.

<Note>
  Para girar uma chave sem interromper a integração, crie a nova chave, atualize a integração e só então revogue a antiga.
</Note>