Criar Chave API
curl --request POST \
--url http://localhost:3000/api/openapi/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Chave de Integração de Produção",
"expires_at": "2026-12-31T23:59:59.000Z"
}
'import requests
url = "http://localhost:3000/api/openapi/v1/api-keys"
payload = {
"name": "Chave de Integração de Produção",
"expires_at": "2026-12-31T23:59:59.000Z"
}
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: 'Chave de Integração de Produção',
expires_at: '2026-12-31T23:59:59.000Z'
})
};
fetch('http://localhost:3000/api/openapi/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/v1/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' => 'Chave de Integração de Produção',
'expires_at' => '2026-12-31T23:59:59.000Z'
]),
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 := "http://localhost:3000/api/openapi/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Chave de Integração de Produção\",\n \"expires_at\": \"2026-12-31T23:59:59.000Z\"\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("http://localhost:3000/api/openapi/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Chave de Integração de Produção\",\n \"expires_at\": \"2026-12-31T23:59:59.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Chave de Integração de Produção\",\n \"expires_at\": \"2026-12-31T23:59:59.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"key_id": "cvz_key_abc123",
"key_secret": "cvz_secret_xyz789",
"name": "Chave de Integração de Produção",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": "Corpo da requisição inválido",
"code": "BAD_REQUEST"
}{
"success": false,
"error": "Credenciais de API inválidas",
"code": "UNAUTHORIZED"
}Chaves API
Criar Chave API
Cria uma nova chave API. O segredo é mostrado apenas uma vez - salve-o com segurança!
POST
/
api
/
openapi
/
v1
/
api-keys
Criar Chave API
curl --request POST \
--url http://localhost:3000/api/openapi/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Chave de Integração de Produção",
"expires_at": "2026-12-31T23:59:59.000Z"
}
'import requests
url = "http://localhost:3000/api/openapi/v1/api-keys"
payload = {
"name": "Chave de Integração de Produção",
"expires_at": "2026-12-31T23:59:59.000Z"
}
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: 'Chave de Integração de Produção',
expires_at: '2026-12-31T23:59:59.000Z'
})
};
fetch('http://localhost:3000/api/openapi/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/v1/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' => 'Chave de Integração de Produção',
'expires_at' => '2026-12-31T23:59:59.000Z'
]),
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 := "http://localhost:3000/api/openapi/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Chave de Integração de Produção\",\n \"expires_at\": \"2026-12-31T23:59:59.000Z\"\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("http://localhost:3000/api/openapi/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Chave de Integração de Produção\",\n \"expires_at\": \"2026-12-31T23:59:59.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Chave de Integração de Produção\",\n \"expires_at\": \"2026-12-31T23:59:59.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"key_id": "cvz_key_abc123",
"key_secret": "cvz_secret_xyz789",
"name": "Chave de Integração de Produção",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": "Corpo da requisição inválido",
"code": "BAD_REQUEST"
}{
"success": false,
"error": "Credenciais de API inválidas",
"code": "UNAUTHORIZED"
}Authorizations
Token JWT obtido do endpoint /api/openapi/auth/token
Body
application/json
Was this page helpful?
⌘I