API
Autenticar via certificado
Autentica um usuário com base nos dados de um certificado digital em base64 e retorna o access_token e refresh_token usando o grant custom_certificate.
POST
/
api
/
auth
/
certificate
Autenticar via certificado
curl --request POST \
--url https://api.valid.com/api/auth/certificate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"client_id": 123,
"client_secret": "<string>",
"certificate": "<string>"
}
'import requests
url = "https://api.valid.com/api/auth/certificate"
payload = {
"client_id": 123,
"client_secret": "<string>",
"certificate": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({client_id: 123, client_secret: '<string>', certificate: '<string>'})
};
fetch('https://api.valid.com/api/auth/certificate', 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://api.valid.com/api/auth/certificate",
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([
'client_id' => 123,
'client_secret' => '<string>',
'certificate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/api/auth/certificate"
payload := strings.NewReader("{\n \"client_id\": 123,\n \"client_secret\": \"<string>\",\n \"certificate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.valid.com/api/auth/certificate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": 123,\n \"client_secret\": \"<string>\",\n \"certificate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/auth/certificate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": 123,\n \"client_secret\": \"<string>\",\n \"certificate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"token_type": "Bearer",
"expires_in": 10800,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGci...",
"refresh_token": "def502001234abc..."
}
{
"error": "Certificado sem dados suficientes."
}
{
"error": "Certificado inválido, revogado ou expirado."
}
Request Body
integer
required
ID do cliente OAuth. Exemplo:
1string
required
Segredo do cliente OAuth. Exemplo:
seu-client-secretstring
required
Certificado digital em base64 (formato X.509). Exemplo:
MIIDdzCCAl+gAwIBAgIEU0B...Response
string
Tipo do token. Exemplo:
Bearerinteger
Tempo de expiração em segundos. Exemplo:
10800string
Token de acesso JWT. Exemplo:
eyJ0eXAiOiJKV1QiLCJhbGci...string
Token para atualização. Exemplo:
def502001234abc...{
"token_type": "Bearer",
"expires_in": 10800,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGci...",
"refresh_token": "def502001234abc..."
}
{
"error": "Certificado sem dados suficientes."
}
{
"error": "Certificado inválido, revogado ou expirado."
}
⌘I
Autenticar via certificado
curl --request POST \
--url https://api.valid.com/api/auth/certificate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"client_id": 123,
"client_secret": "<string>",
"certificate": "<string>"
}
'import requests
url = "https://api.valid.com/api/auth/certificate"
payload = {
"client_id": 123,
"client_secret": "<string>",
"certificate": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({client_id: 123, client_secret: '<string>', certificate: '<string>'})
};
fetch('https://api.valid.com/api/auth/certificate', 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://api.valid.com/api/auth/certificate",
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([
'client_id' => 123,
'client_secret' => '<string>',
'certificate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/api/auth/certificate"
payload := strings.NewReader("{\n \"client_id\": 123,\n \"client_secret\": \"<string>\",\n \"certificate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.valid.com/api/auth/certificate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": 123,\n \"client_secret\": \"<string>\",\n \"certificate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/auth/certificate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": 123,\n \"client_secret\": \"<string>\",\n \"certificate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"token_type": "Bearer",
"expires_in": 10800,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGci...",
"refresh_token": "def502001234abc..."
}
{
"error": "Certificado sem dados suficientes."
}
{
"error": "Certificado inválido, revogado ou expirado."
}