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

# Autenticação

> Crie sua chave de API, envie as credenciais e escolha os escopos.

## Visão geral

A API do DoglyTdc Pay usa **chaves de API** com `client_id` e `client_secret`. Não existe troca por token: você envia as duas partes em toda requisição, sempre por HTTPS.

![Captura de tela: Chaves de API no DoglyTdc Pay](https://mintcdn.com/dogly-tdc/qOnot79kPtISSKbW/images/pay/pay-api.png?fit=max\&auto=format\&n=qOnot79kPtISSKbW\&q=85\&s=3002ebf0377906f83f1b8dbbd6f19284)

Chaves de API no DoglyTdc Pay

## Fluxo de autenticação

```mermaid theme={null}
sequenceDiagram
  participant App as Sua aplicação
  participant Pay as DoglyTdc Pay API
  App->>Pay: GET /products (Authorization: Basic …)
  Pay->>Pay: confere a chave, o segredo e os escopos
  Pay-->>App: 200 { data: [...] }
```

## 1 - Criando a chave de API

**1. Abra o DoglyTdc Pay**

Entre em **DoglyTdc Pay › Integrações › DoglyTdc Pay API**.

**2. Crie a chave**

Dê um nome (ex.: "Minha loja") e marque os escopos.

**3. Copie o segredo**

O `client_secret` aparece **uma única vez**. Guarde num cofre de segredos.

> [!WARNING]
>
> O DoglyTdc guarda só um resumo (hash) do segredo. Se perder, revogue a chave e crie outra.

## 2 - Enviando as credenciais

Três formatos aceitos (use um):

```bash Basic (recomendado) theme={null}
curl https://ucsyxzpdbnuyehizezvb.supabase.co/functions/v1/doglytdc-pay/v1/products \
  -u "dpk_SEU_CLIENT_ID:SEU_CLIENT_SECRET"
```

```bash Bearer theme={null}
curl https://ucsyxzpdbnuyehizezvb.supabase.co/functions/v1/doglytdc-pay/v1/products \
  -H "Authorization: Bearer dpk_SEU_CLIENT_ID:SEU_CLIENT_SECRET"
```

```bash Headers separados theme={null}
curl https://ucsyxzpdbnuyehizezvb.supabase.co/functions/v1/doglytdc-pay/v1/products \
  -H "X-Client-Id: dpk_SEU_CLIENT_ID" \
  -H "X-Client-Secret: SEU_CLIENT_SECRET"
```

## 3 - Escopos de acesso

Cada endpoint exige **todos** os escopos da sua linha. Leituras pedem `read` + o recurso; escritas pedem `write` + o recurso.

| Escopo | Para que serve |
| - | - |
| `read` | Ler dados da conta |
| `write` | Criar e alterar dados (junto com o escopo do recurso) |
| `products` | Produtos |
| `offers` | Ofertas e preços |
| `orders` | Pedidos e reembolsos |
| `subscriptions` | Assinaturas |
| `webhooks` | Listar e criar webhooks |
| `payments` | Links de pagamento |
| `withdrawals_read` | Ver saldo e saques |
| `withdrawals_request` | Pedir saque (sempre com confirmação no app) |

Sem o escopo, a resposta é `403 insufficient_scope` dizendo quais faltam.

## Segurança

* Use a chave **só no servidor**. Nunca coloque no navegador, no app ou num repositório.
* Uma chave por integração, com o mínimo de escopos.
* Revogue na hora qualquer chave exposta, em **Integrações › DoglyTdc Pay API**.
* Reembolsos e links de pagamento sempre pedem a sua aprovação dentro do DoglyTdc Pay.

## Exemplos de clientes

```javascript Node.js theme={null}
const auth = Buffer.from(`${process.env.DPAY_CLIENT_ID}:${process.env.DPAY_CLIENT_SECRET}`).toString("base64");
const res = await fetch("https://ucsyxzpdbnuyehizezvb.supabase.co/functions/v1/doglytdc-pay/v1/orders", { headers: { Authorization: `Basic ${auth}` } });
const { data } = await res.json();
```

```python Python theme={null}
import os, requests
r = requests.get("https://ucsyxzpdbnuyehizezvb.supabase.co/functions/v1/doglytdc-pay/v1/orders", auth=(os.environ["DPAY_CLIENT_ID"], os.environ["DPAY_CLIENT_SECRET"]))
print(r.json()["data"])
```

```php PHP theme={null}
$ch = curl_init("https://ucsyxzpdbnuyehizezvb.supabase.co/functions/v1/doglytdc-pay/v1/orders");
curl_setopt($ch, CURLOPT_USERPWD, getenv("DPAY_CLIENT_ID") . ":" . getenv("DPAY_CLIENT_SECRET"));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$orders = json_decode(curl_exec($ch), true)["data"];
```


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