Criar chave de API

curl --request POST \
  --url https://v4pay-api.vercel.app/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Integração do meu site",
  "environment": "live"
}
'

import requests

url = "https://v4pay-api.vercel.app/api-keys"

payload = {
    "name": "Integração do meu site",
    "environment": "live"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Integração do meu site', environment: 'live'})
};

fetch('https://v4pay-api.vercel.app/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://v4pay-api.vercel.app/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Integração do meu site',
    'environment' => 'live'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://v4pay-api.vercel.app/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"Integração do meu site\",\n  \"environment\": \"live\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://v4pay-api.vercel.app/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Integração do meu site\",\n  \"environment\": \"live\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://v4pay-api.vercel.app/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Integração do meu site\",\n  \"environment\": \"live\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Integração do meu site",
    "prefix": "v4pay_a1b2c3d4",
    "environment": "test",
    "key": "v4pay_a1b2c3d4e5f6...",
    "active": true,
    "last_used_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": "Token JWT ou chave de API ausente"
}

{
  "error": {
    "message": "<string>",
    "codigo": "SOMENTE_PAINEL"
  }
}

POST

api-keys

Criar chave de API

curl --request POST \
  --url https://v4pay-api.vercel.app/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Integração do meu site",
  "environment": "live"
}
'

import requests

url = "https://v4pay-api.vercel.app/api-keys"

payload = {
    "name": "Integração do meu site",
    "environment": "live"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Integração do meu site', environment: 'live'})
};

fetch('https://v4pay-api.vercel.app/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://v4pay-api.vercel.app/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Integração do meu site',
    'environment' => 'live'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://v4pay-api.vercel.app/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"Integração do meu site\",\n  \"environment\": \"live\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://v4pay-api.vercel.app/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Integração do meu site\",\n  \"environment\": \"live\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://v4pay-api.vercel.app/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Integração do meu site\",\n  \"environment\": \"live\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Integração do meu site",
    "prefix": "v4pay_a1b2c3d4",
    "environment": "test",
    "key": "v4pay_a1b2c3d4e5f6...",
    "active": true,
    "last_used_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": "Token JWT ou chave de API ausente"
}

{
  "error": {
    "message": "<string>",
    "codigo": "SOMENTE_PAINEL"
  }
}

Authorizations

Authorization

string

header

required

Token JWT obtido em /auth/login, enviado no cabeçalho Authorization no formato Bearer <token>.

Body

application/json

name

string

required

Example:

"Integração do meu site"

environment

enum<string>

default:live

Ambiente da chave. Define o prefixo (v4pay_test_ / v4pay_live_) e o que a chave alcança. Pode ser diferente do ambiente da sessão que a cria.

Available options:

test,

live

Response

Chave criada; o campo key só aparece aqui.

data

object

Chave de API (o valor completo só aparece na criação, no campo key).

Show child attributes