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

# Criar chave de API

> Passo a passo no dashboard: acessar API, criar, configurar e copiar o secret gp_live_

Crie uma chave `gp_live_...` no dashboard para autenticar chamadas server-to-server com o header `X-API-Key`.

<Warning>
  O secret aparece **uma única vez**. Guarde em variável de ambiente ou secret manager — nunca no Git nem no frontend.
</Warning>

## Pré-requisito

Conta verificada em [app.goatpay.com.br](https://app.goatpay.com.br). Sem verificação, o botão de criar chave fica desabilitado.

## Passo a passo

<Steps>
  <Step title="Acessar API na Dashboard">
    No menu lateral, abra **Integrações → API**, ou acesse direto:

    [app.goatpay.com.br/dashboard/integrations/api](https://app.goatpay.com.br/dashboard/integrations/api)

    <Frame caption="Página de Chaves de API no dashboard">
      <img src="https://mintcdn.com/goatpay/st4Btmc37tsWoyVs/images/tutorials/api-key/01-acessar.png?fit=max&auto=format&n=st4Btmc37tsWoyVs&q=85&s=65ce76d99d78dd111c27e0790b0e9496" alt="Dashboard GoatPay na página Integrações → API, listando chaves de API" width="1918" height="1198" data-path="images/tutorials/api-key/01-acessar.png" />
    </Frame>
  </Step>

  <Step title="Clicar em Nova chave">
    Clique em **Nova chave** no canto superior direito da página (ou no estado vazio, se ainda não houver chaves).

    <Frame caption="Botão Nova chave">
      <img src="https://mintcdn.com/goatpay/st4Btmc37tsWoyVs/images/tutorials/api-key/02-nova-chave.png?fit=max&auto=format&n=st4Btmc37tsWoyVs&q=85&s=ccc871381e6f8de9d47bb89079e035f9" alt="Botão Nova chave destacado na página de Chaves de API" width="1918" height="1198" data-path="images/tutorials/api-key/02-nova-chave.png" />
    </Frame>
  </Step>

  <Step title="Configurar">
    No diálogo **Nova chave**, preencha:

    | Campo                    | O que fazer                                                             |
    | ------------------------ | ----------------------------------------------------------------------- |
    | **Escopo**               | `Leitura`, `Escrita` ou `Completo` — define o conjunto inicial de rotas |
    | **Permissões**           | Ajuste as rotas da API v1 (marque só o necessário)                      |
    | **Permitir qualquer IP** | Deixe marcado se o IP for dinâmico; desmarque para allowlist            |
    | **Descrição**            | Ex.: `ERP Produção`                                                     |

    Clique em **Criar**.

    <Frame caption="Diálogo de configuração da chave">
      <img src="https://mintcdn.com/goatpay/st4Btmc37tsWoyVs/images/tutorials/api-key/03-configurar.png?fit=max&auto=format&n=st4Btmc37tsWoyVs&q=85&s=b3a0ecf241c17c25089f90fd30e9ceb8" alt="Formulário Nova chave com escopo, permissões, IPs e descrição" width="1918" height="1198" data-path="images/tutorials/api-key/03-configurar.png" />
    </Frame>

    Detalhes de permissões: [Permissões da API key](/pages/guides/api-permissions).
  </Step>

  <Step title="Copiar">
    Na tela **Chave criada**, copie o valor `gp_live_...` com **Copiar chave**. Ele **não** será exibido de novo.

    <Frame caption="Secret exibido uma única vez">
      <img src="https://mintcdn.com/goatpay/st4Btmc37tsWoyVs/images/tutorials/api-key/04-copiar.png?fit=max&auto=format&n=st4Btmc37tsWoyVs&q=85&s=341a382f5357fa80ff33a7726ee9a8df" alt="Modal Chave criada com o secret gp_live_ e botão Copiar chave" width="1918" height="1198" data-path="images/tutorials/api-key/04-copiar.png" />
    </Frame>

    Guarde assim:

    ```bash theme={null}
    export GOATPAY_API_KEY=gp_live_SUA_CHAVE
    ```

    Teste rápido:

    ```bash theme={null}
    curl https://api.goatpay.com.br/v1/account/balance \
      -H "X-API-Key: $GOATPAY_API_KEY"
    ```
  </Step>
</Steps>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Primeira integração" icon="rocket" href="/pages/guides/primeira-integracao">
    Do saldo à primeira cobrança PIX com webhook.
  </Card>

  <Card title="Chaves de API" icon="shield" href="/pages/guides/authentication">
    Rotação, trilho PADRAO e boas práticas.
  </Card>
</CardGroup>