Cómo empezar a usar el SDK de Requiply

@requiply/api-sdk es el cliente oficial de TypeScript para la API pública de Requiply. Funciona en Node.js, funciones serverless, Next.js, Nuxt y navegadores, con entradas y respuestas tipadas. Esta página te lleva de cero a una solicitud de reserva en tu cuenta de Requiply en unos diez minutos.

1. Crea una clave de API

Sigue Cómo generar un token de API y elige Secreta. Guárdala en una variable de entorno:

REQUIPLY_SECRET_KEY=rq_sk_live_...

¿Construyes una tienda online que se ejecuta en el navegador? Crea una clave Publicable. Puede hacer todo lo de esta página, pero las reservas se tienen que enviar como solicitudes (asRequest: true).

2. Instala el paquete

npm install @requiply/api-sdk

El paquete es solo ESM. Consulta Instalación para ver los requisitos de entorno.

3. Crea el cliente y haz una primera llamada

import { RequiplyClient } from '@requiply/api-sdk';

const requiply = new RequiplyClient({
  apiKey: process.env.REQUIPLY_SECRET_KEY!,
});

const org = await requiply.org.info();
console.log(org.name);

Si se imprime el nombre de tu organización, la clave funciona. Una clave incorrecta o revocada lanza un RequiplyError con status 401.

4. Busca un artículo y calcula un presupuesto

const startDate = '2026-11-10T10:00:00';
const endDate = '2026-11-12T18:00:00';

const inventory = await requiply.inventory.list({ startDate, endDate });
const item = inventory.items[0];

const quote = await requiply.pricing.quote({
  startDate,
  endDate,
  items: [{ groupId: item.id, quantity: 1 }],
});

console.log(item.name, item.availableQuantity, quote.total, quote.currency);

Las fechas sin desfase horario se leen en la zona horaria de tu organización. Envía siempre una hora: una fecha sola significa medianoche, que suele quedar fuera del horario de apertura. El presupuesto aplica las mismas reglas que la app: tramos de precio, el descuento del cliente y los servicios.

5. Envía una solicitud de reserva

const request = await requiply.bookings.create({
  startDate,
  endDate,
  items: [{ groupId: item.id, quantity: 1 }],
  deliveryType: 'pickup',
  asRequest: true,
  client: { name: 'Sophie', lastName: 'Marlow', email: 'sophie.marlow@example.com' },
});

if (request.success) {
  console.log('Booking request', request.reservationOrgId);
} else {
  console.log('Not accepted:', request.message);
}

El cliente se busca por email, después por teléfono, y si no existe se crea. Una reserva que Requiply no puede aceptar, por ejemplo en un día de cierre o sin unidades libres, se resuelve con success: false y un message en lugar de lanzar un error.

6. Compruébalo en Requiply

1. Solicitud: el estado de una solicitud de reserva. Tu equipo la hace avanzar con la flecha junto a la etiqueta.
2. Cliente: el cliente que el SDK encontró o creó.
3. Periodo de alquiler: las fechas que enviaste, en la zona horaria de tu organización.

La solicitud también aparece en la app móvil, en Reservas.

Preguntas frecuentes

¿Uso el SDK o la API REST?

Usa el SDK en JavaScript y TypeScript. En cualquier otro lenguaje, llama a la API REST con la misma clave; el SDK es una capa fina y tipada sobre ella.

¿Cómo creo una reserva confirmada en lugar de una solicitud?

Usa una clave secreta, omite asRequest y pasa un paymentType. Consulta Reservas.

¿Cómo gestiono los errores?

Captura RequiplyError y lee status y reason. Un 429 incluye retryAfter en segundos. Consulta Gestión de errores.

¿Hay un entorno de pruebas (sandbox)?

No. Todas las claves trabajan con datos reales, así que haz las pruebas en una organización de demostración. Consulta Sin modo de prueba.

Próximos pasos

• Inicio rápido: un ejemplo de servidor y otro de tienda online, uno junto al otro.
• Recursos del SDK: todos los métodos, por recurso.
• Ejemplos: patrones para tiendas online e integraciones.