Récupérer une Demande de Signature

@firma-dev/sdk

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

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

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

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

import requests

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

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}', 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}",
  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}"

	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}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "companies_workspaces_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "sent": true,
    "finished": true,
    "cancelled": true,
    "declined": true,
    "expired": true
  },
  "template_description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "document_page_count": 2,
  "expiration_hours": 123,
  "expires_at": "2023-11-07T05:31:56Z",
  "credit_cost": 123,
  "timestamps": {
    "created_on": "2023-11-07T05:31:56Z",
    "sent_on": "2023-11-07T05:31:56Z",
    "finished_on": "2023-11-07T05:31:56Z",
    "cancelled_on": "2023-11-07T05:31:56Z",
    "declined_on": "2023-11-07T05:31:56Z",
    "last_changed_on": "2023-11-07T05:31:56Z",
    "last_signing_action_on": "2023-11-07T05:31:56Z"
  },
  "settings": {
    "allow_download": true,
    "attach_pdf_on_finish": true,
    "allow_editing_before_sending": false,
    "use_signing_order": true,
    "hand_drawn_only": false,
    "send_signing_email": true,
    "send_finish_email": true,
    "send_expiration_email": true,
    "send_cancellation_email": true,
    "require_otp_verification": null,
    "disable_guided_navigation": true,
    "allow_presigning_download": true,
    "show_qr_code": true,
    "identity_editable_fields": [
      "<string>"
    ],
    "notify_identity_change_email": false
  },
  "certificate": {
    "generated": true,
    "generated_on": "2023-11-07T05:31:56Z",
    "has_error": true
  },
  "final_document_download_url": "<string>",
  "document_only_download_url": "<string>",
  "certificate_only_download_url": "<string>"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

GET

signing-requests

{id}

@firma-dev/sdk

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

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

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

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

import requests

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

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}', 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}",
  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}"

	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}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "companies_workspaces_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": {
    "sent": true,
    "finished": true,
    "cancelled": true,
    "declined": true,
    "expired": true
  },
  "template_description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "document_page_count": 2,
  "expiration_hours": 123,
  "expires_at": "2023-11-07T05:31:56Z",
  "credit_cost": 123,
  "timestamps": {
    "created_on": "2023-11-07T05:31:56Z",
    "sent_on": "2023-11-07T05:31:56Z",
    "finished_on": "2023-11-07T05:31:56Z",
    "cancelled_on": "2023-11-07T05:31:56Z",
    "declined_on": "2023-11-07T05:31:56Z",
    "last_changed_on": "2023-11-07T05:31:56Z",
    "last_signing_action_on": "2023-11-07T05:31:56Z"
  },
  "settings": {
    "allow_download": true,
    "attach_pdf_on_finish": true,
    "allow_editing_before_sending": false,
    "use_signing_order": true,
    "hand_drawn_only": false,
    "send_signing_email": true,
    "send_finish_email": true,
    "send_expiration_email": true,
    "send_cancellation_email": true,
    "require_otp_verification": null,
    "disable_guided_navigation": true,
    "allow_presigning_download": true,
    "show_qr_code": true,
    "identity_editable_fields": [
      "<string>"
    ],
    "notify_identity_change_email": false
  },
  "certificate": {
    "generated": true,
    "generated_on": "2023-11-07T05:31:56Z",
    "has_error": true
  },
  "final_document_download_url": "<string>",
  "document_only_download_url": "<string>",
  "certificate_only_download_url": "<string>"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

Autorisations

Authorization

string

header

requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

string<uuid>

requis

Réponse

Demande de signature récupérée avec succès. Renvoie une structure imbriquée détaillée avec le statut sous forme d'objet et les horodatages regroupés ensemble.

Demande de Signature détaillée telle que renvoyée par GET /signing-requests/{id} (structure imbriquée avec un objet status et des horodatages)

string<uuid>

requis

Identifiant unique de la demande de signature

name

string

requis

Nom de la demande de signature

companies_workspaces_id

string<uuid>

requis

ID de l'espace de travail auquel appartient cette demande de signature

status

object

requis

Indicateurs de statut (plusieurs peuvent être vrais pour les états terminaux)

Show child attributes

template_description

string | null

Description issue du modèle

document_url

string<uri>

URL pré-signée vers le document PDF

document_url_expires_at

string<date-time> | null

document_page_count

integer

Nombre de pages du document

Plage requise: x >= 1

expiration_hours

integer

Nombre d'heures avant l'expiration de la demande de signature

expires_at

string<date-time> | null

Horodatage ISO 8601 correspondant à l'expiration de la demande de signature. Calculé à partir de sent_on + expiration_hours. Null si elle n'a pas encore été envoyée ou si aucun expiration_hours n'est défini.

credit_cost

integer

Crédits consommés lors de l'envoi

timestamps

object

Tous les horodatages pertinents pour le cycle de vie de la demande de signature

Show child attributes

settings

object

Paramètres renvoyés par les endpoints de liste et de détail des demandes de signature. Les modèles utilisent le schéma TemplateSettings (sans champs d'identité).

Show child attributes

use_signing_order

enum<integer>

obsolète

Options disponibles:

0,

1

allow_download

enum<integer>

obsolète

Options disponibles:

0,

1

allow_editing_before_sending

enum<integer>

obsolète

Options disponibles:

0,

1

hand_drawn_only

enum<integer>

obsolète

Options disponibles:

0,

1

attach_pdf_on_finish

enum<integer>

obsolète

Options disponibles:

0,

1

certificate

object | null

Informations sur le statut de génération du certificat

Show child attributes

final_document_download_url

string<uri> | null

URL signée pour télécharger le document final signé (PDF avec certificat). L'URL expire après 1 heure.

final_document_download_error

enum<string> | null

Options disponibles:

file_not_accessible,

null

document_only_download_url

string<uri> | null

URL signée pour télécharger le PDF du document seul. L'URL expire après 1 heure.

document_only_download_error

enum<string> | null

Options disponibles:

file_not_accessible,

null

certificate_only_download_url

string<uri> | null

URL signée pour télécharger le PDF du certificat seul. L'URL expire après 1 heure.

certificate_only_download_error

enum<string> | null

Options disponibles:

file_not_accessible,

null

Créer et Envoyer une Demande de Signature (Atomique)Télécharger le document de la demande de signature

⌘I