API de acortamiento de enlaces de Linkly
Crea, actualiza y gestiona enlaces mediante programación utilizando la API de acortamiento de enlaces de Linkly.
Relacionado: API de análisis | Webhooks
Antes de comenzar
Linkly genera solicitudes de API en la interfaz para que las copies y pegues en tus aplicaciones.
Esto funciona para la creación de enlaces y la actualización de enlaces.
Ahorra tiempo y deja que nosotros hagamos el trabajo difícil:
- 1Consulta a continuación las solicitudes de API para crear enlaces.
- 2Copia las solicitudes en su totalidad. Puedes verificar que funcionen para ti.
- 3Pídele a ChatGPT o equivalente que adapte estas solicitudes en código fuente para tu aplicación. No hay necesidad de dedicar tiempo a una integración compleja. Nuestra API es completamente consumible por máquinas.
Especificación OpenAPI 3.0
Puedes generar solicitudes de API directamente desde la interfaz de usuario de Linkly.
Constructor de API de acortamiento de enlaces de Linkly
La API de acortamiento de enlaces de Linkly construye solicitudes de API automáticamente basándose en el contenido del formulario. Puedes pegar el texto proporcionado aquí en cualquier LLM para generar automáticamente código para tu aplicación.
La API de Linkly está documentada utilizando el estándar OpenAPI, que va más allá de lo que se proporciona a continuación. Los mismos puntos finales también están disponibles como una colección de Postman de un clic.
Autorización
Necesitarás:
- Tu clave de API
- ID del área de trabajo
Puedes obtener estos detalles dentro de Linkly.
- 1Inicia sesión en Linkly.
- 2Haz clic en Configuración.
- 3Haz clic en Claves de API.
Crear o actualizar un enlace
Para crear un enlace, todo lo que necesitas hacer es enviar una solicitud POST a:
https://app.linklyhq.com/api/v1/link
con los siguientes campos en el cuerpo.
El tipo de codificación es x-www-form-urlencoded o application/json.
Si envías el campo Rules, debes usar application/json.
Te recomendamos que uses JSON con la especificación de API abierta.
| Etiqueta | Clave | Tipo | Notas |
|---|---|---|---|
| Clave de API de cuenta | api_key | Cadena | Requerido |
| ID del área de trabajo | workspace_id | Entero | Requerido |
| ID del enlace | id | Entero | Requerido si se actualiza un enlace existente |
| Destino | url | Cadena | Requerido |
| Apodo | name | Cadena | |
| Notas | note | Cadena | |
| Etiquetas de retargeting (región head) | head_tags | Cadena | Para píxeles de retargeting |
| Etiquetas de retargeting (región body) | body_tags | Cadena | Para píxeles de retargeting |
| Reenviar parámetros | forward_params | Booleano | |
| Ocultar referente | hide_referrer | Booleano | Envía referrer-policy: no-referrer para que el destino no vea Linkly en el encabezado de referencia |
| Enmascaramiento | cloaking | Booleano | Oculta la URL de destino detrás de un marco |
| Bloquear bots | block_bots | Booleano | Bloquea bots/rastreadores conocidos |
| Omitir seguimiento de rastreador social | skip_social_crawler_tracking | Booleano | Cuando block_bots está activado, aún permite que los rastreadores sociales pasen para que funcionen las vistas previas de OG |
| Analytics públicos | public_analytics | Booleano | Habilita la página /abc123.stats pública para este enlace |
| Contraseña | password | Cadena | Los visitantes deben ingresar esta contraseña antes de redirigirse |
| Estado de publicación | enabled | Booleano | |
| Fuente UTM | utm_source | Cadena | Para seguimiento de UTM |
| Medio UTM | utm_medium | Cadena | Para seguimiento de UTM |
| Campaña UTM | utm_campaign | Cadena | Para seguimiento de UTM |
| Término UTM | utm_term | Cadena | Para seguimiento de UTM |
| Contenido UTM | utm_content | Cadena | Para seguimiento de UTM |
| Dominio personalizado | domain | Cadena | Requerido si se proporciona slug. Ver dominios personalizados |
| Sufijo de dominio personalizado | slug | Cadena | Si se proporciona dominio y slug es nulo, se generará automáticamente |
| Título de Open Graph | og_title | Cadena | Para vistas previas de redes sociales |
| Descripción de Open Graph | og_description | Cadena | Para vistas previas de redes sociales |
| URL de imagen de Open Graph | og_image | Cadena | Para vistas previas de redes sociales |
| ID de Meta Pixel | fb_pixel_id | Cadena | Para Meta Pixel |
| ID de píxel de TikTok | tiktok_pixel_id | Cadena | |
| ID de Google Analytics 4 | ga4_tag_id | Cadena | |
| Contenedor de Google Tag Manager | gtm_id | Cadena | |
| Linkify palabras | linkify_words | Cadena | Frases separadas por saltos de línea que deben acortarse automáticamente en páginas de destino |
| Reemplazos | replacements | Cadena | Reglas de reemplazo de texto aplicadas a la página de destino |
| Fecha y hora de vencimiento | expiry_datetime | Cadena ISO8601 DateTime | Para enlaces que vencen |
| Destino de vencimiento | expiry_destination | Cadena (URL) | Para enlaces que vencen. Debe comenzar con http. |
| Clics de vencimiento | expiry_clicks | Entero | Vence el enlace después de estos clics |
| Webhooks | webhooks | Array de cadenas | URLs de webhook por enlace. Ver webhooks. |
| Notificar IDs de usuario | notify_user_ids | Array de enteros | IDs de usuario del área de trabajo a notificar en cada clic |
| Estilos de código QR | qr_styles | Objeto JSON | Para estilo de código QR. Claves: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Reglas | rules | Array JSON | Para rotadores, redirecciones geográficas, y redirecciones de dispositivos |
Solicitud de ejemplo usando curl
El código a continuación ilustra cómo hacer una solicitud de API para crear un enlace.
curl -X POST https://app.linklyhq.com/api/v1/link
-H 'cache-control: no-cache'
-d 'api_key=your_secret_key&workspace_id=1&url=http%3A%2F%2Fwww.wikijob.co.uk&name=Test%20Link'
Una respuesta exitosa devolverá un objeto JSON que representa el enlace, junto con un ID de enlace.
{
"id": 9512,
"url": "https://www.wikijob.co.uk",
"name": "Test Link",
"note": null,
"head_tags": null,
"body_tags": null,
"linkify_words": null,
"replacements": null,
"enabled": true,
"cloaking": false,
"forward_params": false,
"hide_referrer": false,
"block_bots": false,
"skip_social_crawler_tracking": false,
"public_analytics": false,
"password": null,
"domain": null,
"slug": null,
"utm_source": null,
"utm_medium": null,
"utm_campaign": null,
"utm_term": null,
"utm_content": null,
"og_title": null,
"og_description": null,
"og_image": null,
"fb_pixel_id": null,
"tiktok_pixel_id": null,
"ga4_tag_id": null,
"gtm_id": null,
"full_url": "https://l.linklyhq.com/l/2TQ",
"rules": [],
"expiry_datetime": null,
"expiry_destination": null,
"expiry_clicks": null,
"qr_styles": null,
"webhooks": [],
"notify_user_ids": [],
"workspace_id": 1448,
"deleted": false
}
Actualizar un enlace
Para actualizar un enlace, envía la misma solicitud que usarías para crear el enlace, pero incluye el campo id para el enlace que deseas actualizar, así como los cambios.
Crear rotadores a través de API
Para crear un rotador, envía un campo llamado rules como un array JSON, junto con la carga útil del enlace anterior. Debes usar application/json para enviar arrays JSON.
Por ejemplo:
[
{"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
{"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]
Crear redirecciones geográficas a través de API
Para redirigir por país, envía un campo llamado rules como un array JSON, junto con la carga útil del enlace anterior. Debes usar codificación application/json para enviar arrays JSON.
Por ejemplo:
[
{"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
{"what": "country", "url": "https://www.apple.com", "matches": "US"}
]
El país es el código de país ISO 3166 alfa-2.
Crear redirecciones de dispositivos a través de API
Para redirigir por dispositivo, envía un campo llamado rules como un array JSON, junto con la carga útil del enlace anterior.
Por ejemplo:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Donde el campo matches es uno de:
- ios
- android
- windows
- linux
- mac
Crear o actualizar múltiples enlaces en una solicitud
Linkly admite la creación/enmienda de hasta 1000 enlaces por solicitud.
Para hacerlo, envía tu clave de API como parte de la solicitud de la siguiente manera:
https://app.linklyhq.com/api/v1/links?api_key=XXXXXXXXXXX
Luego, usa el mismo esquema que el anterior para los casos de enlaces individuales, pero envuelve las solicitudes de enlaces en un array, de la forma:
[{link}, {link}]
Aquí hay una solicitud completa que actualizará dos enlaces:
wget --no-check-certificate \
--method POST \
--timeout=0 \
--header 'Content-Type: application/json' \
--body-data '[
{
"workspace_id": "WORKSPACE_ID",
"url": "https://nature.com",
"name": "Test",
"id": LINK_ID
},
{
"workspace_id": "WORKSPACE_ID",
"url": "https://science.com",
"id": LINK_ID
}
]' \
'https://app.linklyhq.com/api/v1/links?api_key=API_KEY'
Esto funciona tanto para acciones de creación como de actualización.
Ten en cuenta que puede tomar hasta 60 segundos para una solicitud grande. Si las solicitudes tardan más que esto, fallarán, y deberías considerar dividir tu carga de trabajo en fragmentos más pequeños.
Límites de velocidad
La API de acortamiento de enlaces está limitada a 20 solicitudes/segundo. Hasta 200 solicitudes por segundo están disponibles bajo solicitud. Puedes cargar hasta 1000 enlaces en una sola solicitud.
Relacionado
- API de análisis - Exporta datos de clics e informes de tráfico
- Webhooks - Notificaciones de clics en tiempo real
- Integración de Zapier - Integraciones sin código
Disponibilidad del plan
Incluido en todos los planes
Rastrea 500 clics mensuales con todas las funciones incluidas.