@firma-dev/sdk

import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.signingRequests.downloadSigningRequest({
    id: "id"
});
console.log(response);

curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

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

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download', 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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download")

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

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

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

{
  "is_partial": true,
  "download_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "generated_at": "2023-11-07T05:31:56Z"
}

Solicitudes de Firma

Descargar Documento de la Solicitud de Firma

Recupera una URL de descarga para el documento firmado de una solicitud de firma. Para solicitudes de firma completadas, devuelve el PDF firmado final. Para solicitudes de firma en curso donde la descarga parcial está habilitada, devuelve una URL al documento parcialmente firmado generado en el momento en que el último firmante completó su firma.

Descargas parciales: Las descargas parciales solo están disponibles cuando la solicitud de firma tiene allow_partial_download habilitado en su configuración. Si el documento aún no se ha generado parcialmente, se devuelve un 503; reintenta después del intervalo indicado en Retry-After.

Expiración de la URL: download_url es una URL prefirmada que expira. La marca de tiempo de expiración se proporciona en expires_at.

GET

signing-requests

{id}

download

@firma-dev/sdk

import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.signingRequests.downloadSigningRequest({
    id: "id"
});
console.log(response);

curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

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

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download', 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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/download")

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

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

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

{
  "is_partial": true,
  "download_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "generated_at": "2023-11-07T05:31:56Z"
}

Autorizaciones

Authorization

string

header

requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de ruta

string<uuid>

requerido

ID de la solicitud de firma

Respuesta

URL de descarga obtenida correctamente.

status

enum<string>

requerido

Estado de la Solicitud de Firma. finished significa que todos los Firmantes han completado el proceso. in_progress significa que la firma sigue en curso y esta es una descarga parcial. cancelled, declined y expired indican estados terminales donde el documento es una instantánea parcial del momento en que terminó la firma.

Opciones disponibles:

finished,

in_progress,

cancelled,

declined,

expired

is_partial

boolean

requerido

Si esta URL de descarga apunta a un documento parcialmente firmado (no todos los Firmantes han completado el proceso).

download_url

string<uri>

requerido

URL prefirmada para descargar el documento PDF. Expira en el momento indicado por expires_at.

expires_at

string<date-time>

requerido

Marca de tiempo ISO 8601 de cuándo expira download_url. Vuelve a llamar a este endpoint para obtener una URL nueva después de que expire.

generated_at

string<date-time> | null

Marca de tiempo ISO 8601 de cuándo se generó el documento por última vez. Para descargas parciales, es cuándo se creó el PDF parcial.

Obtener Solicitud de Firma Recuperar la Imagen de Firma del Firmante

⌘I