# Conta

> Verifique uma chave: a conta de cliente por trás dela, seus escopos, plano e limite de requisições.

<!-- Generated from openapi/hills-v1.json by scripts/api-reference.mjs. Edit the operation in hills-music (server/lib/ops), not this page. -->

Verifique uma chave: a conta de cliente por trás dela, seus escopos, plano e limite de requisições.

URL base `https://api.hillsmusic.com/v1`. Toda requisição envia uma chave de API: `Authorization: Bearer hm_live_…`.

- Quem sou eu
- Verificação de conexão

<a id="who-am-i"></a>

## Quem sou eu

`GET /v1/me` · Qualquer chave válida

A conta de cliente dona da chave, e o nome, os escopos e a validade da própria chave. Útil para verificar se uma chave funciona.

### Exemplo de requisição

```bash
curl "https://api.hillsmusic.com/v1/me" \
  -H "Authorization: Bearer $HILLS_API_KEY"
```

### Resposta `200`

```json
{
  "partner": {
    "id": 12,
    "name": "Nova Records",
    "email": "ops@novarecords.com"
  },
  "environment": "production",
  "key": {
    "id": 3,
    "name": "ERP sync",
    "prefix": "hm_live_ab12cd34",
    "environment": "production",
    "scopes": [
      "catalog:read",
      "earnings:read"
    ],
    "expires_at": null,
    "created_at": "2026-10-01T09:00:00Z"
  }
}
```

### Erros

| Status | Quando |
| --- | --- |
| 401 | unauthenticated, invalid_key, key_revoked, key_expired ou test_keys_retired. |
| 403 | account_inactive ou api_not_in_plan. |
| 429 | rate_limited: aguarde Retry-After segundos. |

<a id="connection-check"></a>

## Verificação de conexão

`GET /v1/ping` · Qualquer chave válida

Qualquer chave válida: a conta, o plano, os escopos da chave, o limite de requisições restante e a hora do servidor. A chamada aparece na página de entrega DDEX (Connection, Activity).

### Exemplo de requisição

```bash
curl "https://api.hillsmusic.com/v1/ping" \
  -H "Authorization: Bearer $HILLS_API_KEY"
```

### Resposta `200`

```json
{
  "ok": true,
  "environment": "production",
  "server_time": "2026-10-07T09:00:00.000Z",
  "account": {
    "id": 12,
    "name": "Nova Records",
    "email": "ops@novarecords.com"
  },
  "plan": {
    "included": true,
    "plan": "enterprise",
    "rate": 120
  },
  "key": {
    "prefix": "hm_live_ab12cd34",
    "scopes": [
      "ddex:write"
    ]
  },
  "rate_limit": {
    "limit": 120,
    "remaining": 119
  }
}
```

### Erros

| Status | Quando |
| --- | --- |
| 401 | unauthenticated, invalid_key, key_revoked, key_expired ou test_keys_retired. |
| 403 | account_inactive ou api_not_in_plan. |
| 429 | rate_limited: aguarde Retry-After segundos. |

Fonte: https://developer.hillsmusic.com/pt/reference/account/