Generar Enlace de Carpeta

POST

https://app.firmeasy.legal/api/v1/digital/carpeta/enlace

Generar Enlace de Carpeta

Este endpoint te permite generar un enlace temporal para dar acceso a una carpeta específica dentro del flujo de Firma Digital. Es ideal para compartir lotes de documentos de forma segura con terceros.

Autorización

Este recurso está protegido. Debes incluir tu token de acceso en el encabezado de la petición.

Parámetro	Tipo	Descripción	Límites
`Authorization`	string	Token de acceso obtenido en el proceso de login, precedido por la palabra 'Bearer'.	Obligatorio
`Content-Type`	string	Especifica el formato del cuerpo de la petición.	application/json

Authorization

string

Token de acceso obtenido en el proceso de login, precedido por la palabra 'Bearer'.

Límites:Obligatorio

Content-Type

string

Especifica el formato del cuerpo de la petición.

Límites:application/json

Parámetros de la Petición

Campos Obligatorios

Los campos marcados con un asterisco (*) son obligatorios y deben ser proporcionados en la solicitud. Los demás campos son opcionales.

Envía los siguientes parámetros en el cuerpo (body) de tu petición POST en formato JSON.

Parámetro	Tipo	Descripción	Límites
`carpeta_id`	string	Token o identificador único (UUID) de la carpeta que deseas compartir.	Obligatorio (Formato UUID)
`tiempo`	integer	Tiempo de validez o expiración del enlace generado.	Obligatorio (Número entero)

carpeta_id

string

Token o identificador único (UUID) de la carpeta que deseas compartir.

Límites:Obligatorio (Formato UUID)

tiempo

integer

Tiempo de validez o expiración del enlace generado.

Límites:Obligatorio (Número entero)

Ejemplos de Implementación

Aquí tienes los fragmentos de código listos para probar la generación del enlace.

cURL

curl -X POST [https://app.firmeasy.legal/api/v1/digital/carpeta/enlace](https://app.firmeasy.legal/api/v1/digital/carpeta/enlace) \
  -H "Authorization: Bearer TU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "carpeta_id": "59288b30-0305-40c6-90f4-d6da2d9750ce",
    "tiempo": 5
  }'

Node.js (Fetch)

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer TU_TOKEN_AQUI");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "carpeta_id": "59288b30-0305-40c6-90f4-d6da2d9750ce",
  "tiempo": 5
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("[https://app.firmeasy.legal/api/v1/digital/carpeta/enlace](https://app.firmeasy.legal/api/v1/digital/carpeta/enlace)", requestOptions)
  .then((response) => response.json())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Estructura de Respuesta

Nota para el equipo de Desarrollo: La estructura del JSON de respuesta exitosa (200 OK) para este endpoint está pendiente de actualización en la documentación oficial.

Nombre	Tipo	Descripción
`url_enlace`	string	[Estructura referencial] El enlace temporal generado para acceder a la carpeta.

url_enlace

string

[Estructura referencial] El enlace temporal generado para acceder a la carpeta.

Códigos de Estado

Código	Estado	Descripción
`200`	OK	El enlace temporal se generó correctamente.
`400`	Bad Request	Los parámetros enviados no tienen el formato correcto (ej. `tiempo` no es un número).
`401`	Unauthorized	El token no fue enviado o ha expirado.
`404`	Not Found	No se encontró la carpeta con el ID proporcionado.
`500`	Server Error	Falla interna en los servidores de Firmeasy.