Crear un expediente

POST
/api/documentset

Crea un expediente vacío y devuelve su id.

Un expediente agrupa varios documentos en un solo paquete de firma: una invitación, un orden de firma, una conclusión. El ciclo es:

  1. POST /api/documentset — crear el expediente.
  2. POST /developers/json con document_set — agregar cada documento.
  3. POST /api/documentset/close — cerrarlo y arrancar el flujo.

Autenticación

signmage
Authorization<token>

Cada petición lleva Authorization: signmage {webId}:{firma}, donde firma es el Base64 de HMAC-SHA256(apiKey, cadenaFirmada).

Qué va dentro de cadenaFirmada depende de la petición:

PeticióncadenaFirmada
GETLa URI completa incluyendo el query string, exactamente como se envía
POST con JSONEl cuerpo JSON, re-serializado compacto (sin espacios ni salto de línea final)
POST multipartEl SHA-256 en Base64 del archivo, que además se manda en el header Content-SHA256

Dos detalles que conviene resolverlos desde el principio:

  1. En GET, la URI se firma tal como se envía, así que el orden y el encoding de los parámetros importan.
  2. En POST, la comparación se hace contra tu JSON re-serializado en forma compacta. Manda JSON compacto y canónico para que las firmas coincidan.

Una firma que no coincide devuelve 401 con el cuerpo vacío. Como la misma respuesta cubre un web ID desconocido, una llave inactiva y una firma que no coincide, revisa las tres cosas al diagnosticar.

En: header

Cuerpo de la petición

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

curl -X POST "https://example.com/api/documentset" \  -H "Content-Type: application/json" \  -d '{    "name": "Expediente de contratación"  }'
{  "document_set": "7c320b07-5b71-4ef4-8b8e-7db8cb1d8f21"}