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:

  1. 1
    Consulta a continuación las solicitudes de API para crear enlaces.
  2. 2
    Copia las solicitudes en su totalidad. Puedes verificar que funcionen para ti.
  3. 3
    Pí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.

Ver especificación OpenAPI

Ejecutar en Postman

Autorización

Necesitarás:

  • Tu clave de API
  • ID del área de trabajo

Puedes obtener estos detalles dentro de Linkly.

  1. 1
    Inicia sesión en Linkly.
  2. 2
    Haz clic en Configuración.
  3. 3
    Haz 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.

EtiquetaClaveTipoNotas
Clave de API de cuentaapi_keyCadenaRequerido
ID del área de trabajoworkspace_idEnteroRequerido
ID del enlaceidEnteroRequerido si se actualiza un enlace existente
DestinourlCadenaRequerido
ApodonameCadena
NotasnoteCadena
Etiquetas de retargeting (región head)head_tagsCadenaPara píxeles de retargeting
Etiquetas de retargeting (región body)body_tagsCadenaPara píxeles de retargeting
Reenviar parámetrosforward_paramsBooleano
Ocultar referentehide_referrerBooleanoEnvía referrer-policy: no-referrer para que el destino no vea Linkly en el encabezado de referencia
EnmascaramientocloakingBooleanoOculta la URL de destino detrás de un marco
Bloquear botsblock_botsBooleanoBloquea bots/rastreadores conocidos
Omitir seguimiento de rastreador socialskip_social_crawler_trackingBooleanoCuando block_bots está activado, aún permite que los rastreadores sociales pasen para que funcionen las vistas previas de OG
Analytics públicospublic_analyticsBooleanoHabilita la página /abc123.stats pública para este enlace
ContraseñapasswordCadenaLos visitantes deben ingresar esta contraseña antes de redirigirse
Estado de publicaciónenabledBooleano
Fuente UTMutm_sourceCadenaPara seguimiento de UTM
Medio UTMutm_mediumCadenaPara seguimiento de UTM
Campaña UTMutm_campaignCadenaPara seguimiento de UTM
Término UTMutm_termCadenaPara seguimiento de UTM
Contenido UTMutm_contentCadenaPara seguimiento de UTM
Dominio personalizadodomainCadenaRequerido si se proporciona slug. Ver dominios personalizados
Sufijo de dominio personalizadoslugCadenaSi se proporciona dominio y slug es nulo, se generará automáticamente
Título de Open Graphog_titleCadenaPara vistas previas de redes sociales
Descripción de Open Graphog_descriptionCadenaPara vistas previas de redes sociales
URL de imagen de Open Graphog_imageCadenaPara vistas previas de redes sociales
ID de Meta Pixelfb_pixel_idCadenaPara Meta Pixel
ID de píxel de TikToktiktok_pixel_idCadena
ID de Google Analytics 4ga4_tag_idCadena
Contenedor de Google Tag Managergtm_idCadena
Linkify palabraslinkify_wordsCadenaFrases separadas por saltos de línea que deben acortarse automáticamente en páginas de destino
ReemplazosreplacementsCadenaReglas de reemplazo de texto aplicadas a la página de destino
Fecha y hora de vencimientoexpiry_datetimeCadena ISO8601 DateTimePara enlaces que vencen
Destino de vencimientoexpiry_destinationCadena (URL)Para enlaces que vencen. Debe comenzar con http.
Clics de vencimientoexpiry_clicksEnteroVence el enlace después de estos clics
WebhookswebhooksArray de cadenasURLs de webhook por enlace. Ver webhooks.
Notificar IDs de usuarionotify_user_idsArray de enterosIDs de usuario del área de trabajo a notificar en cada clic
Estilos de código QRqr_stylesObjeto JSONPara estilo de código QR. Claves: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
ReglasrulesArray JSONPara 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

Disponibilidad del plan

Incluido en todos los planes

Comparar planes →

Rastrea 500 clics mensuales con todas las funciones incluidas.