Skip to main content
POST

Autorizações

x-api-key
string
header
obrigatório

Sua chave de API ps_

Parâmetros de caminho

id
string
obrigatório

O id do número ao qual a chave está vinculada — o id (ou o id da instância) que GET /v1/numbers devolve. Ele é CONFERIDO contra o número da própria credencial, nunca usado para procurar um.

Corpo

application/json
confirm
enum<boolean>

Tem de ser o booleano true, exatamente. ⛔ NÃO é sempre obrigatório: é exigido exatamente quando a chamada SUBSTITUI UMA CHAVE VIVA — ou seja, quando já existe uma chave nossa viva na Meta (uploadedAt diferente de null) — e essa regra vale para OS DOIS verbos, gerar e importar. A primeira configuração não pergunta, e repetir um par que a Meta nunca aceitou também não. O que ele reconhece muda com o verbo: ao gerar, que a chave registrada na Meta é SUBSTITUÍDA e todos os Flows data_exchange deste número deixam de decifrar; ao importar, que a metade privada guardada aqui é SUBSTITUÍDA, o que quebra a decifragem do nosso lado se a Meta não conseguir confirmar a chave importada.

Opções disponíveis:
true
Exemplo:

true

privateKey
string

O PEM de uma chave privada que você JÁ tem, cuja metade pública a Meta tem registrada para este número. ⛔ A PRESENÇA dele é o que transforma este POST de GERAR em IMPORTAR: enviado, nada é registrado na Meta e só a metade privada guardada muda; omitido, um par novo é criado e a metade pública dele REGISTRADA na Meta. Tem de ser string não vazia — privateKey: 42 dá 400 FLOW_ENDPOINT_KEY_IMPORT_INVALID e nunca é convertido. Envie o conteúdo do arquivo .pem inteiro, incluindo as linhas -----BEGIN …----- e -----END …-----. RSA, 2048 bits ou mais; um PEM protegido por passphrase é aceito junto de passphrase. Se a metade pública dele não for a que a Meta tem, a resposta é 400 FLOW_ENDPOINT_KEY_IMPORT_MISMATCH e nada é escrito.

Minimum string length: 1
Exemplo:

"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQ...\n-----END PRIVATE KEY-----\n"

passphrase
string

A passphrase que abre privateKey, quando o PEM está cifrado. Opcional, e só faz sentido junto de privateKey: ⛔ enviada sozinha é RECUSADA com 400 FLOW_ENDPOINT_KEY_PASSPHRASE_ORPHAN em vez de ignorada, porque um privateKey digitado errado cairia senão no GERAR e substituiria o registro na Meta. Tem de ser string. Um PEM cifrado sem passphrase dá 400 FLOW_ENDPOINT_KEY_PASSPHRASE_REQUIRED; uma passphrase que não o abre dá 400 FLOW_ENDPOINT_KEY_PASSPHRASE_WRONG — dois códigos, porque são dois consertos diferentes.

Exemplo:

"a-passphrase-que-abre-o-pem"

Resposta

Agora existe um par de chaves no número. GERAR também registrou a metade pública na Meta; IMPORTAR não registrou NADA — nesse caso, uploadedAt: null com metaStatus UNKNOWN/NOT_SET significa que a chave foi GUARDADA e a Meta não a confirmou, que é a única coisa que um 200 sozinho não conta. replaced diz se uma chave que estava VIVA acabou de ser deslocada — um 200 sozinho não diz