Obter configurações do certificado local

GET

signer

sign

:sessionToken

web-pki

settings

Obter configurações do certificado local

curl --request GET \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings', 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/signer/v1/sign/:sessionToken/web-pki/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available": true,
  "license": "ABCDEF1234567890...",
  "restPkiUrl": "https://restpki.lacunasoftware.com"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available": false,
  "license": null,
  "restPkiUrl": null
}

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Session expired"
}

Obtém as configurações e a licença do plugin Web PKI (da Lacuna), necessárias para o signatário assinar usando um certificado A1 instalado no computador ou A3 em token/smartcard. Autenticação: use apenas o sessionToken na URL — nenhum header de autenticação é necessário.

Parâmetros

string

required

Token único da sessão do signatário.

Respostas

boolean

Se a modalidade de certificado local está disponível. false se WEB_PKI_LICENSE não está configurada no ambiente.

string

Licença do plugin Web PKI emitida pela Lacuna para seu domínio. Necessária para inicializar o plugin no navegador. Presente apenas se available: true.

string

URL base do serviço Lacuna RestPKI que o plugin do navegador precisa contactar. Presente apenas se available: true.

Erros

Veja Autenticação e erros.

410: Session token expirado (envelope expirou ou foi deletado).

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available": true,
  "license": "ABCDEF1234567890...",
  "restPkiUrl": "https://restpki.lacunasoftware.com"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available": false,
  "license": null,
  "restPkiUrl": null
}

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Session expired"
}

Exemplo

curl -X GET "https://api.valid.com/signer/v1/sign/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.../web-pki/settings" \
  -H "Content-Type: application/json"

Importante

Disponibilidade: sem WEB_PKI_LICENSE configurada no servidor, a resposta é available: false — a modalidade não deve ser oferecida ao signatário.
Licença pública: a licença é um valor público que vai diretamente no JavaScript da página (exposição não é problema de segurança).
Plugin necessário: o signatário precisa ter a extensão Web PKI instalada no navegador. Se não tiver, o plugin oferece download automático.

Próximas etapas

Se available: true:

Inicialize o plugin Web PKI com a licença recebida: pki.init({ license })
Liste certificados: pki.listCertificates()
Deixe o signatário escolher um certificado
Chame POST .../web-pki/start com o certificado escolhido
Use o token devolvido no plugin: pki.signWithRestPki({ token, thumbprint })
Chame POST /signer/v1/sign/:sessionToken/sign para finalizar

Relacionado

POST .../web-pki/start — preparar assinatura com certificado escolhido
POST /signer/v1/sign/:sessionToken/sign — finalizar assinatura
GET /signer/v1/sign/:sessionToken — obter dados da sessão

⌘I

Obter configurações do certificado local

curl --request GET \
  --url https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings', 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/signer/v1/sign/:sessionToken/web-pki/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/sign/:sessionToken/web-pki/settings")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available": true,
  "license": "ABCDEF1234567890...",
  "restPkiUrl": "https://restpki.lacunasoftware.com"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available": false,
  "license": null,
  "restPkiUrl": null
}

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Session expired"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Obter configurações do certificado local

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado

​Parâmetros

​Respostas

​Erros

​Exemplo

​Importante

​Próximas etapas

​Relacionado

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado