Passer au contenu principal
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"
}

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

id
string<uuid>
requis

ID de la demande de signature

Réponse

URL de téléchargement récupérée avec succès.

status
enum<string>
requis

Statut de la Demande de Signature. finished signifie que tous les Signataires ont terminé. in_progress signifie que la signature est encore en cours et qu'il s'agit d'un téléchargement partiel. cancelled, declined et expired indiquent des états terminaux où le document est un instantané partiel pris au moment où la signature s'est arrêtée.

Options disponibles:
finished,
in_progress,
cancelled,
declined,
expired
is_partial
boolean
requis

Indique si cette URL de téléchargement pointe vers un document partiellement signé (tous les Signataires n'ont pas terminé).

download_url
string<uri>
requis

URL pré-signée pour télécharger le document PDF. Expire au moment indiqué par expires_at.

expires_at
string<date-time>
requis

Horodatage ISO 8601 d'expiration de download_url. Interrogez à nouveau cet endpoint pour obtenir une URL fraîche après expiration.

generated_at
string<date-time> | null

Horodatage ISO 8601 de la dernière génération du document. Pour les téléchargements partiels, c'est le moment où le PDF partiel a été créé.