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

# User Token e User Secret Key

A autenticação garante a segurança e privacidade dos dados dos usuários. Nesta API, utilize os headers `User-Token` e `User-Secret-Key` em todas as requisições. Ambos são obrigatórios.

## Como obter suas credenciais

No painel administrativo da Yampi, acesse `Perfil > Credenciais de API` no canto superior direito para encontrar suas credenciais.

<Warning>As credenciais de API são renovadas automaticamente quando a senha de acesso do usuário é alterada.</Warning>

***

## Verificando o Usuário Autenticado

Após obter o `User-Token` e o `User-Secret-Key`, você pode utilizar o endpoint abaixo para consultar os dados do usuário autenticado, incluindo as lojas associadas, status de assinatura e permissões de acesso.

### Endpoint

```http theme={"system"}
POST https://api.dooki.com.br/v2/auth/me 
```

### Headers

| Nome            | Valor               |
| --------------- | ------------------- |
| Content-Type    | `application/json`  |
| User-Token      | `{user-token}`      |
| User-Secret-Key | `{user-secret-key}` |

***

### Exemplo de Requisição

```bash theme={"system"}
curl -X POST https://api.dooki.com.br/v2/auth/me \
  -H "Content-Type: application/json" \
  -H "User-Token: {{user-token}}" \
  -H "User-Secret-Key: {{user-secret-key}}"
```

***

### Exemplo de Resposta

```json theme={"system"}
{
  "data": {
    "id": 987654,
    "active": true,
    "name": "João Silva",
    "social_name": null,
    "email": "joao.silva@example.com",
    "temporary_email": null,
    "is_owner": true,
    "agree": true,
    "merchant_owner": true,
    "super_user": false,
    "last_login_at": "2025-07-15 14:22:10",
    "avatar_url": "https://secure.gravatar.com/avatar/abc123?s=80&d=identicon",
    "allow_notifications": true,
    "type": "user",
    "created_at": {
      "date": "2023-01-10 09:30:00.000000",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "created_at_timestamp": 1673343000,
    "updated_at": {
      "date": "2025-07-10 16:45:00.000000",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "confirmed_at": "2023-01-10 10:00:00",
    "mfa_enabled": true,
    "cpf": "000.000.000-00",
    "birthday": "1990-05-20",
    "phone": "(11) 91234-5678",
    "address_street": "Rua das Flores",
    "address_number": "123",
    "address_neighborhood": "Centro",
    "address_complement": "Apto 45",
    "address_city": "São Paulo",
    "address_state": "SP",
    "address_zipcode": "01000-000",
    "merchants": {
      "data": [
        {
          "id": 123456,
          "alias": "loja-exemplo",
          "name": "Loja Exemplo",
          "profile": "store_v2",
          "domain": "www.lojaexemplo.com.br",
          "base_url": "https://www.lojaexemplo.com.br",
          "is_marketplace": false,
          "is_partner": false,
          "use_only_checkout": false,
          "active": true,
          "internal_active": false,
          "has_subscription": true,
          "has_charges": true,
          "has_credit_card": true,
          "owner_id": 987654,
          "owner_email": "joao.silva@example.com",
          "tags": [],
          "domains_list": ["www.lojaexemplo.com.br"],
          "icon_url": null,
          "logo_url": null,
          "created_at": {
            "date": "2023-02-15 10:00:00.000000",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "updated_at": {
            "date": "2025-06-20 17:00:00.000000",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "subscription": {
            "plan": "Pro",
            "status": "active"
          },
          "has_services": {
            "shopifyapp": false,
            "bling": true,
            "woocommerce": true,
            "mago": false,
            "tiny": false
          }
        }
      ]
    },
    "group": {
      "data": []
    },
    "notification_types": {
      "data": []
    },
    "lead_data": {
      "data": []
    }
  }
}
```

***

## Campos da Resposta

<AccordionGroup>
  <Accordion title="Dados do Usuário">
    * `id`
    * `active`
    * `name`
    * `social_name`
    * `email`
    * `temporary_email`
    * `is_owner`
    * `agree`
    * `merchant_owner`
    * `super_user`
    * `last_login_at`
    * `avatar_url`
    * `allow_notifications`
    * `type`
    * `created_at.date`
    * `created_at.timezone_type`
    * `created_at.timezone`
    * `created_at_timestamp`
    * `updated_at.date`
    * `updated_at.timezone_type`
    * `updated_at.timezone`
    * `confirmed_at`
    * `mfa_enabled`
    * `cpf`
    * `birthday`
    * `phone`
    * `address_street`
    * `address_number`
    * `address_neighborhood`
    * `address_complement`
    * `address_city`
    * `address_state`
    * `address_zipcode`
  </Accordion>

  <Accordion title="Lojas">
    * `id`
    * `preset_id`
    * `active`
    * `internal_active`
    * `is_marketplace`
    * `is_partner`
    * `use_only_checkout`
    * `profile`
    * `alias`
    * `has_domain`
    * `domain`
    * `base_url`
    * `name`
    * `icon_url`
    * `logo_url`
    * `has_subscription`
    * `has_charges`
    * `has_marketplace_accounts`
    * `has_shopify`
    * `has_affiliations`
    * `coupon_created`
    * `order_bump_created`
    * `upsell_created`
    * `pixel_created`
    * `owner_id`
    * `owner_email`
    * `owner_created_at`
    * `domains_list[]`
    * `tags[]`
    * `created_at.date`
    * `created_at.timezone_type`
    * `created_at.timezone`
    * `updated_at.date`
    * `updated_at.timezone_type`
    * `updated_at.timezone`
  </Accordion>

  <Accordion title="Assinatura da Loja">
    * `plan`
    * `status`
  </Accordion>

  <Accordion title="Serviços da Loja">
    * `shopifyapp`
    * `bling`
    * `woocommerce`
    * `mago`
    * `tiny`
  </Accordion>

  <Accordion title="Outros Campos">
    * `group.data[]`
    * `notification_types.data[]`
    * `lead_data.data[]`
  </Accordion>
</AccordionGroup>

***

### Observações Técnicas

* Essa rota **não requer payload no corpo da requisição**.
* Retorna todos os dados do usuário com base no token enviado.
* Pode ser usada para identificar o dono da loja, checar permissões e validar assinatura.