Rotacionar o segredo - Valora Payments

Rotacionar o segredo

curl --request POST \
  --url https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "we_Xk2v9QeR7tLmN3bA",
  "object": "webhook_endpoint",
  "url": "<string>",
  "description": "<string>",
  "events": [
    "payment.succeeded"
  ],
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "secret": "whsec_..."
}

{
  "error": {
    "type": "invalid_api_key",
    "message": "Chave de API inválida ou revogada."
  }
}

{
  "error": {
    "type": "missing_scope",
    "message": "A chave não tem o escopo necessário."
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Não encontrado."
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

POST

/

v1

/

webhooks

/

{endpoint_id}

/

rotate_secret

Rotacionar o segredo

curl --request POST \
  --url https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/rotate_secret",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "we_Xk2v9QeR7tLmN3bA",
  "object": "webhook_endpoint",
  "url": "<string>",
  "description": "<string>",
  "events": [
    "payment.succeeded"
  ],
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "secret": "whsec_..."
}

{
  "error": {
    "type": "invalid_api_key",
    "message": "Chave de API inválida ou revogada."
  }
}

{
  "error": {
    "type": "missing_scope",
    "message": "A chave não tem o escopo necessário."
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Não encontrado."
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

Autorizações

Authorization

string

header

obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Parâmetros de caminho

endpoint_id

string

obrigatório

Id do endpoint.

Pattern: ^we_[A-Za-z0-9_-]{16}$

Resposta

Endpoint com o novo segredo.

id

string

Id do endpoint.

Pattern: ^we_[A-Za-z0-9_-]{16}$

Exemplo:

"we_Xk2v9QeR7tLmN3bA"

object

enum<string>

Sempre webhook_endpoint.

Opções disponíveis:

webhook_endpoint

url

string<uri>

URL que recebe os eventos.

description

string | null

Descrição.

events

enum<string>[]

Eventos assinados. * = todos.

Opções disponíveis:

payment.succeeded,

payment.expired,

payment.failed,

payment.canceled,

payment.refunded,

payment.disputed,

payment.dispute_won,

payment.dispute_lost,

*

status

enum<string>

Estado.

Opções disponíveis:

active,

disabled

created_at

string<date-time>

Criação.

secret

string

Segredo HMAC (whsec_...). Aparece só nesta resposta: guarde.

Exemplo:

"whsec_..."