Documentación inicial
API y SDK
Lo mínimo verificado hoy y lo que falta publicar.
Referencia
Especificación y paquete
Esta es la documentación mínima verificada. La documentación completa, los ejemplos por lenguaje y el entorno de pruebas de Forklink se publicarán al abrir el servicio.
Especificación OpenAPI
El producto de enlaces expone su especificación OpenAPI 3 en /openapi.json (cabecera Cache-Control: public, max-age=300) y una referencia interactiva en /docs. Cubre enlaces, dominios, etiquetas, grupos, UTM, webhooks, aplicaciones móviles y deep links, analítica, conversiones y páginas de enlaces.
Próximamente: la dirección pública de la especificación de Forklink (prevista en api.forklink.co) se publicará al abrir. Todavía no existe.
La referencia de la API se genera del OpenAPI real y sus ejemplos se ejecutaron contra staging.
SDK de JavaScript/TypeScript
npm install @customyai/links @customyai/coreAutenticación con una llave cl_live_… o cl_test_…, o con tokens de máquina. Reintenta lecturas y borrados ante errores de red, 429 y 5xx; un POST no se repite solo. Los webhooks se verifican con verifyWebhook(rawBody, headers, secret).
Estado real de los paquetes (npm, consultado el 2026-11-09)
@customyai/links— recomendado. Publicado: 0.1.3. En el repositorio está la 0.2.0 (aplicaciones móviles y deep links v2), sin publicar.@customyai/links-sdk— obsoleto. Publicado: 0.3.3. El repositorio marca el paquete como obsoleto (0.4.0 sin publicar, un adaptador sobre@customyai/links); no lo uses en proyectos nuevos.- El nombre del paquete propio de Forklink está por decidir; hoy no existe ningún paquete llamado Forklink.
Qué falta
Pendiente de publicar
- Dirección pública de la especificación y de la referencia interactiva de Forklink.
- Ejemplos por lenguaje y guía de inicio rápido con llaves de pruebas.
- Límites de uso por plan (dependen de los precios, que no están aprobados).
- Estado del servicio (
status.forklink.co).