@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";
const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });
const response = await firma.customFields.createSigningRequestCustomField({
request_id: "request_id",
field_label: "field_label"
});
console.log(response);curl --request POST \
--url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "<string>",
"field_name": "<string>"
}
'import requests
url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields"
payload = {
"field_label": "<string>",
"field_name": "<string>"
}
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({field_label: '<string>', field_name: '<string>'})
};
fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields', 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/{request_id}/custom-fields",
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([
'field_label' => '<string>',
'field_name' => '<string>'
]),
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/signing-requests/{request_id}/custom-fields"
payload := strings.NewReader("{\n \"field_label\": \"<string>\",\n \"field_name\": \"<string>\"\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/signing-requests/{request_id}/custom-fields")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field_label\": \"<string>\",\n \"field_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields")
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 \"field_label\": \"<string>\",\n \"field_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_label": "<string>",
"copied_from_template": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Validation Error",
"message": "Invalid input data",
"details": {
"name": "Name is required",
"email": "Invalid email format"
}
}{
"error": "Unauthorized",
"message": "Invalid API key"
}{
"error": "Not Found",
"message": "The requested resource was not found"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Campos Personalizados
Crear campo personalizado de la solicitud de firma
Crea una nueva definición de campo personalizado para una solicitud de firma
POST
/
signing-requests
/
{request_id}
/
custom-fields
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";
const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });
const response = await firma.customFields.createSigningRequestCustomField({
request_id: "request_id",
field_label: "field_label"
});
console.log(response);curl --request POST \
--url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "<string>",
"field_name": "<string>"
}
'import requests
url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields"
payload = {
"field_label": "<string>",
"field_name": "<string>"
}
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({field_label: '<string>', field_name: '<string>'})
};
fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields', 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/{request_id}/custom-fields",
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([
'field_label' => '<string>',
'field_name' => '<string>'
]),
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/signing-requests/{request_id}/custom-fields"
payload := strings.NewReader("{\n \"field_label\": \"<string>\",\n \"field_name\": \"<string>\"\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/signing-requests/{request_id}/custom-fields")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field_label\": \"<string>\",\n \"field_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{request_id}/custom-fields")
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 \"field_label\": \"<string>\",\n \"field_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_label": "<string>",
"copied_from_template": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Validation Error",
"message": "Invalid input data",
"details": {
"name": "Name is required",
"email": "Invalid email format"
}
}{
"error": "Unauthorized",
"message": "Invalid API key"
}{
"error": "Not Found",
"message": "The requested resource was not found"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Autorizaciones
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
Cuerpo
application/json
Respuesta
Campo personalizado creado correctamente
Una definición de campo personalizado para una Solicitud de Firma
¿Esta página le ayudó?
Listar campos personalizados de la solicitud de firmaEliminar campo personalizado de la solicitud de firma
⌘I