> For the complete documentation index, see [llms.txt](https://ereemby.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ereemby.gitbook.io/docs/desenvolvedores/chave-de-api.md).

# Chave de API

### Como gerar sua Chave de API da Ereemby

Para consumir a API da **Ereemby**, você precisa gerar uma **Chave de API**.\
Ela será usada para autenticar suas requests.

{% hint style="danger" %}
**Atenção:** a chave é confidencial. Não compartilhe.\
Não envie para GitHub. Não coloque em print público.
{% endhint %}

{% stepper %}
{% step %}

### Passo 1 — Abra a página de API no painel

Acesse o painel da Ereemby:\
<https://ereemby.com/dashboard/api>
{% endstep %}

{% step %}

### Passo 2 — Copie a sua chave

Na seção de API, copie a chave exibida.

<figure><img src="https://2689733486-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3dDDJrzdKjZTltqBHmfD%2Fuploads%2F9kMb2iCy6eeKY66p7Jj3%2Fimage.png?alt=media&amp;token=412ba6d4-2085-4bd9-ae42-03a6eeb77d27" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Passo 3 — Use a chave nas suas requests

Use a chave como token de autenticação na sua integração.

Exemplo de header (padrão Bearer):

```http
x-api-key: SUA_CHAVE_DE_API
```

{% endstep %}
{% endstepper %}

### Formato da chave

A sua chave é gerada no formato UUID, por exemplo:

```
a1b2c3d4-e5f6-4789-a123-456789abcdef
```

{% hint style="info" %}
Se a chave vazar, gere outra e atualize todas as integrações que usam a antiga.
{% endhint %}