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

# Configurar Sua Loja BukioPay e Gerenciar a API Key

> Entenda como sua loja BukioPay funciona, como consultar seus dados via API, onde encontrar sua API Key e como substituí-la caso seja comprometida.

A sua loja BukioPay é a entidade central que une sua API Key, produtos, pedidos e toda a configuração de pagamentos. Cada requisição autenticada à API está vinculada a uma loja específica, identificada pelo Bearer Token informado no cabeçalho `Authorization`. Esta página explica os principais conceitos sobre sua loja e como consultá-la e gerenciá-la via API.

## Dados da loja

O objeto de loja retornado pela API contém os seguintes campos:

| Campo | Tipo | Descrição |
| - | - | - |
| `id` | `string` | Identificador único da loja na BukioPay. |
| `name` | `string` | Nome da loja exibido para clientes e no Dashboard. |
| `slug` | `string` | Identificador amigável da loja, utilizado em URLs públicas (ex: `minha-loja`). |
| `api_key` | `string` | Sua chave de autenticação para a API. Sempre começa com `sk_live_`. |
| `description` | `string` | Descrição da loja, exibida em páginas públicas de checkout. |
| `image` | `string` | URL da imagem ou logotipo da loja. |
| `created_at` | `string` | Data e hora de criação da loja no formato ISO 8601. |

## Consultando dados da loja

Para recuperar as informações da sua loja, utilize o endpoint `GET /stores/me/store` com sua `api_key` no cabeçalho de autenticação:

```bash theme={null}
curl -X GET 'https://api.bukiopay.com/api/v1/stores/me/store' \
  --header 'Authorization: Bearer sk_live_sua_api_key'
```

A resposta bem-sucedida retorna o objeto completo da loja:

```json theme={null}
{
  "store": {
    "id": "store_123",
    "name": "Minha Loja",
    "slug": "minha-loja",
    "api_key": "sk_live_...",
    "description": "Descrição da loja",
    "image": "https://...",
    "created_at": "2026-01-01T00:00:00.000Z"
  }
}
```

## Gerenciando sua API Key

Sua `api_key` é a credencial que autentica todas as requisições feitas à API da BukioPay em nome da sua loja. Trate-a com o mesmo cuidado que uma senha.

**Onde encontrar sua API Key:** Acesse o **Dashboard BukioPay** → **Configurações da Loja**. Sua `api_key` estará exibida na seção de credenciais de API.

**Como substituir uma API Key comprometida:** Caso você suspeite que sua `api_key` foi exposta, acesse o **Dashboard** → **Configurações da Loja** e utilize a opção de **Regenerar API Key**. Uma nova chave será gerada imediatamente, e a antiga será invalidada.

<Warning>
  **Nunca commite sua `api_key` em repositórios de código-fonte**, mesmo que o repositório seja privado. Utilize variáveis de ambiente (ex: `process.env.BUKIOPAY_API_KEY`) e um arquivo `.env` listado no `.gitignore` para manter suas credenciais seguras.
</Warning>

<Tip>
  Ao rodar sua aplicação em produção, configure a `api_key` como uma variável de ambiente no seu serviço de hospedagem (ex: Vercel, Railway, AWS). Nunca exponha a chave no código do frontend.
</Tip>

***

<CardGroup cols={2}>
  <Card title="Ver detalhes da loja" icon="store" href="/api-reference/store/details">
    Consulte a referência completa do endpoint de detalhes da loja.
  </Card>

  <Card title="Autenticação" icon="key" href="/authentication">
    Saiba como autenticar corretamente todas as requisições à API BukioPay.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.