Documentación de la API para generación de firmas

⚡ Inicio rápido

Tres pasos desde el registro hasta tu primera firma.

🔗 URL base

Todas las respuestas son JSON. En caso de éxito: { "success": true, "data": {…}, "meta": {…} }; en caso de error: { "success": false, "error": { "code", "message" } }.

https://onlinesignatures.net/api/v1

🔑 Autenticación

Cada solicitud necesita un token Bearer en la cabecera Authorization. Crea y gestiona las claves en la página de API de tu cuenta: la clave completa se muestra una sola vez.

curl https://onlinesignatures.net/api/v1/usage \
  -H "Authorization: Bearer sk_live_your_token"

🎨 Formatos de salida

Por defecto, la firma se devuelve como PNG con fondo transparente. Añade el parámetro format para obtener otro formato; no consume cuota adicional.

Claves = cuántas claves de API puedes crear en este plan. Solicitudes / mes es la cuota principal; solicitudes / minuto es el límite contra ráfagas.

🔍 Calidad de imagen

De forma predeterminada, la firma se devuelve en calidad estándar (1×). Añade el parámetro quality para obtener una imagen más grande y nítida: 2× tiene el doble de píxeles y 4× el cuádruple. No consume cuota adicional.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"png",
      "quality":4}'

La misma firma con otra calidad

Para obtener exactamente la misma firma con otra calidad, guarda el hash de la respuesta y vuelve a solicitarla con POST /api/v1/signatures/replay. Cada llamada cuenta como una solicitud.

curl -X POST https://onlinesignatures.net/api/v1/signatures/replay \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"hash":"eyJpdiI6...",
      "format":"png",
      "quality":4}'

Genera una firma nueva a partir de un nombre y un apellido.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator"}'

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"pdf"}'

Parámetros

{
  "success": true,
  "data": {
    "id": 1842,
    "hash": "eyJpdiI6...",
    "format": "pdf",
    "mime": "application/pdf",
    "signature": "data:application/pdf;
       base64,JVBER..."
  },
  "meta": { "quota": { "remaining":179 } }
}

{
  "success": false,
  "error": {
    "code": "format_not_allowed",
    "message": "The pdf format is
      not available on
      your plan."
  }
}

Vuelve a generar una firma creada anteriormente por su hash. También puedes indicar el formato con ?format=.

curl "https://onlinesignatures.net/api/v1/signatures/{hash}?format=svg" \
  -H "Authorization: Bearer sk_live_your_token"

Devuelve tu plan, los formatos disponibles, el límite mensual, lo que has usado y cuándo se reinicia.

{
  "success": true,
  "data": {
    "plan": "Business",
    "formats": ["png", "svg", "jpg"],
    "rate_per_minute": 1000,
    "key": { "name": "Production", "masked": "sk_live_a1b2…8f9c" },
    "quota": { "limit": 500, "used": 321, "remaining": 179 }
  }
}

⏱️ Límites y cuota

La cuota mensual es el límite principal y depende de tu plan (consulta Planes de API). Además, un límite de solicitudes por minuto (también por plan) protege frente a ráfagas. Las respuestas incluyen las cabeceras X-Quota-Limit, X-Quota-Remaining y X-Quota-Reset para autorregularte. Cambiar de formato no consume cuota adicional: una generación = una solicitud.

⚠️ Códigos de error