Desarrolladores

Una API, un SDK, webhooks que llegan.

Usted accede a la API con una cuenta activada; el SDK de TypeScript se descarga desde el portal para desarrolladores, con sus claves.

Portal de desarrolladores: SDK de TypeScript versionado (huella SHA-256), primeros pasos con una clave API

Empezar

Empezar en tres pasos

  1. Una clave de cuenta

    La crea en el portal para desarrolladores una vez activada su cuenta.

  2. El SDK de TypeScript

    Versionado, descargado desde el portal, con su huella visible.

  3. Su primera llamada

    Cree una expedición, reciba la URL de seguimiento.

Webhooks

Webhooks que llegan

Usted crea una suscripción, la prueba con un ping y consulta el historial de entrega. Cada evento sale de una bandeja de salida y se reintenta hasta su entrega; lo que falla de forma persistente queda visible en la cola de fallidos.

Alcance

Lo que cubre la API

Pedidos y expediciones

Crear, leer, seguir; presupuestos firmados y compra de etiqueta.

Seguimiento

Eventos de transportista, página de seguimiento pública.

Catálogo y stock

Referencias, correspondencia de SKU, posición de stock.

Devoluciones

Devoluciones con fotos y reingreso en stock.

Checkout alojado

Franjas horarias, puntos de recogida, cupones.

EDI y AS2

EDI X12, PIVOT/EANCOM, recepción AS2.

Claves de socio

Claves de cuenta, claves de socio

Sus claves de cuenta se crean y se renuevan desde el portal para desarrolladores. Las claves con alcance de socio —para un transportista o un almacén de la red— las emite un administrador de Ysend, con un alcance limitado a la cuenta.

Crear una expedición con el SDK
import { YsendClient } from "@ysend/sdk";

const ysend = new YsendClient({ apiKey: process.env.YSEND_API_KEY });

const shipment = await ysend.shipments.create({
  orderRef: "SHIP-2026-0501",
  parcels: [{ weightKg: 1.2 }],
  to: { country: "FR", postalCode: "06700" },
});
console.log(shipment.trackingUrl);

Obtener acceso a la API

Una cuenta activada le da acceso a la API, al SDK y a los webhooks.

Obtener acceso a la APIVer las integraciones

Una persona configura su cuenta en un día hábil.