Saltar al contenido principal
POST
/
documents
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

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

const response = await firma.signingRequests.uploadDocument({
    file_name: "contract.pdf",
    file_size: 15000000,
    content_type: "application/pdf"
});
console.log(response);
curl --request POST \
--url https://api.firma.dev/functions/v1/signing-request-api/documents \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"file_name": "contract.pdf",
"file_size": 15000000,
"content_type": "application/pdf"
}
'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/documents"

payload = {
"file_name": "contract.pdf",
"file_size": 15000000,
"content_type": "application/pdf"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
file_name: 'contract.pdf',
file_size: 15000000,
content_type: 'application/pdf'
})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/documents', 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/documents",
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([
'file_name' => 'contract.pdf',
'file_size' => 15000000,
'content_type' => 'application/pdf'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$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.firma.dev/functions/v1/signing-request-api/documents"

payload := strings.NewReader("{\n \"file_name\": \"contract.pdf\",\n \"file_size\": 15000000,\n \"content_type\": \"application/pdf\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<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.firma.dev/functions/v1/signing-request-api/documents")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"file_name\": \"contract.pdf\",\n \"file_size\": 15000000,\n \"content_type\": \"application/pdf\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/documents")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_name\": \"contract.pdf\",\n \"file_size\": 15000000,\n \"content_type\": \"application/pdf\"\n}"

response = http.request(request)
puts response.read_body
{
  "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "upload_url": "<string>",
  "upload_token": "<string>",
  "expires_in": 3600
}

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.

Cuerpo

application/json
file_name
string
requerido

Nombre del archivo del documento

Maximum string length: 255
Ejemplo:

"contract.pdf"

file_size
integer
requerido

Tamaño del archivo en bytes. Máximo 50MB (52,428,800 bytes).

Rango requerido: 1 <= x <= 52428800
Ejemplo:

15000000

content_type
enum<string>
requerido

Tipo MIME del documento

Opciones disponibles:
application/pdf,
application/vnd.openxmlformats-officedocument.wordprocessingml.document
Ejemplo:

"application/pdf"

Respuesta

URL de subida creada

document_id
string<uuid>

ID del documento a pasar en la solicitud de firma

upload_url
string<uri>

URL prefirmada para hacer PUT del archivo del documento. Envía los bytes del archivo en bruto con el Content-Type coincidiendo con el content_type solicitado.

upload_token
string

Token de autenticación de subida (incluido en el upload_url)

expires_in
integer

Segundos hasta que la URL de subida expire

Ejemplo:

3600