API Keys

Listar API keys

Apenas tenant-scoped (uma key escopada a número recebe 403 NUMBER_SCOPE_NOT_ALLOWED, e uma concessão OAuth precisa ser de tenant completo). Retorna uma lista enxuta e plana — um item por número do tenant — com numberId, number, displayName, keyId, keyLast4 e o valor real utilizável (campo key) quando a chave foi criada com criptografia ativa (revealable: true). Chaves antigas vêm com key: null e revealable: false (regenere aquele número para obter um valor utilizável).

Requer uma chave com escopo de tenant.

GET

api-keys

Listar API keys

curl --request GET \
  --url https://pilotstatus.com.br/v1/api-keys \
  --header 'x-api-key: <api-key>'

[
  {
    "numberId": "wn_1",
    "number": "5511999999999",
    "displayName": "Suporte",
    "keyId": "k_aaa",
    "keyLast4": "wxyz",
    "key": "ps_4f1c...real...wxyz",
    "revealable": true
  },
  {
    "numberId": "wn_2",
    "number": "5511888888888",
    "displayName": "Vendas",
    "keyId": "k_bbb",
    "keyLast4": "abcd",
    "key": null,
    "revealable": false
  }
]

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Resposta

Listar keys (key do tenant — todos os números)

Dashboard de analytics

Regenerar API key de um número

⌘I

Listar API keys

curl --request GET \
  --url https://pilotstatus.com.br/v1/api-keys \
  --header 'x-api-key: <api-key>'

[
  {
    "numberId": "wn_1",
    "number": "5511999999999",
    "displayName": "Suporte",
    "keyId": "k_aaa",
    "keyLast4": "wxyz",
    "key": "ps_4f1c...real...wxyz",
    "revealable": true
  },
  {
    "numberId": "wn_2",
    "number": "5511888888888",
    "displayName": "Vendas",
    "keyId": "k_bbb",
    "keyLast4": "abcd",
    "key": null,
    "revealable": false
  }
]