Leypal API Docs

Guía de Inicio Rápido

Haz tu primera llamada API en 5 minutos.

Guía de Inicio Rápido

Pasarás de cero a tu primera llamada API exitosa en menos de 10 minutos. Al final, tendrás una Clave API, un comando curl funcional y un camino claro para construir tu integración.

Prerrequisitos

Antes de comenzar, asegúrate de tener:

  • Una cuenta de Leypal con acceso API habilitado (regístrate aquí si es necesario)
  • curl instalado — o cualquier cliente HTTP que prefieras (Postman, Insomnia, HTTPie)
  • 5 minutos

Paso 1: Genera Tu Clave API

Tiempo estimado: 2 minutos

Tu Clave API autentica cada solicitud que realizas. Mantenla en secreto — trátala como una contraseña.

  1. Inicia sesión en el Panel de control de Leypal
  2. Navega a Configuración → Claves API
  3. Haz clic en Generar nueva clave
  4. Dale un nombre (ej., mi-integracion-dev) y selecciona los permisos que necesitas
  5. Copia la clave — comienza con sk_live_ para producción o sk_test_ para el entorno de pruebas

Nota de seguridad: Tu Clave API se muestra solo una vez. Guárdala en una variable de entorno o en un gestor de secretos — nunca la confirmes en control de versiones.

# Guarda tu clave en una variable de entorno (recomendado)
export LEYPAL_API_KEY="sk_live_tu_clave_aqui"

Paso 2: Haz Tu Primera Solicitud

Tiempo estimado: 1 minuto

Vamos a obtener tus firmas existentes — una llamada de solo lectura y segura para verificar que tu clave funciona.

curl -X GET https://api.leypal.dev/api/v1/signatures \
  -H "Authorization: Bearer YOUR_API_KEY"

Usando una variable de entorno (recomendado):

curl -X GET https://api.leypal.dev/api/v1/signatures \
  -H "Authorization: Bearer $LEYPAL_API_KEY"

Reemplaza YOUR_API_KEY con la clave que generaste en el Paso 1, o usa la variable $LEYPAL_API_KEY si la exportaste.

Paso 3: Entendiendo la Respuesta

Tiempo estimado: 1 minuto

Una respuesta exitosa devuelve HTTP 200 OK con un cuerpo JSON:

{
  "data": [
    {
      "id": "sig_01hq2k3m4n5p6q7r8s9t0u",
      "title": "Service Agreement Q1 2026",
      "status": "pending",
      "createdAt": "2026-03-15T14:30:00Z",
      "signers": [
        {
          "email": "client@example.com",
          "status": "pending"
        }
      ]
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "perPage": 20
  }
}

Campos principales:

CampoDescripción
dataArreglo de solicitudes de firma
data[].idIdentificador único — úsalo para solicitudes posteriores
data[].statusEstado actual: draft, pending, completed, cancelled
data[].signersLista de firmantes y su estado individual
meta.totalNúmero total de registros (para paginación)

Si tu cuenta aún no tiene firmas, data será un arreglo vacío [] — eso es lo esperado.

Paso 4: Maneja Errores Comunes

Tiempo estimado: 1 minuto

Código de estado HTTPErrorCausaSolución
401 UnauthorizedCredenciales inválidasClave API faltante o incorrectaVerifica la clave en Configuración → Claves API; regenera si es necesario
403 ForbiddenPermisos insuficientesLa clave no tiene el permiso signatures:readEdita la clave en Configuración → Claves API y habilita el permiso requerido
429 Too Many RequestsLímite de velocidad excedidoMás de 1,000 solicitudes por minutoEspera 60 segundos y vuelve a intentarlo; implementa backoff exponencial para producción

Próximos Pasos

Has realizado tu primera llamada API. Aquí tienes a dónde ir a continuación:

On this page

Guía de Inicio RápidoPrerrequisitosPaso 1: Genera Tu Clave APIPaso 2: Haz Tu Primera SolicitudPaso 3: Entendiendo la RespuestaPaso 4: Maneja Errores ComunesPróximos Pasos