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
/
v1
/
api-keys
Listar API keys
curl --request GET \
--url https://pilotstatus.com.br/v1/api-keys \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/api-keys"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/api-keys"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/api-keys")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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
}
]{
"error": "Unauthorized"
}{
"error": "Number-scoped keys cannot call tenant endpoints",
"code": "NUMBER_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}Autorizações
apiKeyapiKeyId
Sua chave de API ps_
Resposta
Listar keys (key do tenant — todos os números)
Esta página foi útil?
⌘I
Listar API keys
curl --request GET \
--url https://pilotstatus.com.br/v1/api-keys \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/api-keys"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/api-keys"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/api-keys")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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
}
]{
"error": "Unauthorized"
}{
"error": "Number-scoped keys cannot call tenant endpoints",
"code": "NUMBER_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}