API de raccourcissement de liens Linkly

Créez, mettez à jour et gérez des liens par programme à l'aide de l'API de raccourcissement de liens de Linkly.

Connexe : API Analytics | Webhooks

Avant de commencer

Linkly génère des demandes API dans l'interface pour que vous les copiiez et les colliez dans vos applications.

Cela fonctionne pour la création de liens et la mise à jour de liens.

Gagnez du temps et laissez-nous faire le travail difficile :

  1. 1
    Voir ci-dessous pour les demandes API de création de liens.
  2. 2
    Copiez les demandes dans leur intégralité. Vous pouvez vérifier qu'elles fonctionnent pour vous.
  3. 3
    Demandez à ChatGPT ou un équivalent d'adapter ces demandes en code source pour votre application. Il n'est pas nécessaire de passer du temps à effectuer une intégration complexe. Notre API est entièrement lisible par machine.

Spécification OpenAPI 3.0

Vous pouvez générer des demandes API directement à partir de l'interface utilisateur de Linkly.

Générateur d'API de raccourcissement de liens Linkly

L'API de raccourcissement de liens de Linkly crée automatiquement des demandes API en fonction du contenu du formulaire. Vous pouvez coller le texte fourni ici dans n'importe quel LLM pour générer automatiquement du code pour votre application.

L'API de Linkly est documentée selon la norme OpenAPI, qui va au-delà de ce qui est fourni ci-dessous. Les mêmes points de terminaison sont également disponibles en tant que collection Postman en un clic.

Voir la spécification OpenAPI

Exécuter dans Postman

Autorisation

Vous aurez besoin de :

  • Votre clé API
  • ID de l'espace de travail

Vous pouvez obtenir ces détails à partir de Linkly.

  1. 1
    Connectez-vous à Linkly.
  2. 2
    Cliquez sur Paramètres.
  3. 3
    Cliquez sur Clés API.

Créer ou mettre à jour un lien

Pour créer un lien, il vous suffit d'envoyer une demande POST à :

https://app.linklyhq.com/api/v1/link

avec les champs suivants dans le corps.

Le type d'encodage est x-www-form-urlencoded ou application/json.

Si vous soumettez le champ Rules, vous devez utiliser application/json.

Nous vous recommandons d'utiliser JSON avec la spécification Open API.

ÉtiquetteCléTypeNotes
Clé API du compteapi_keyStringObligatoire
ID de l'espace de travailworkspace_idIntegerObligatoire
ID du lienidIntegerObligatoire si mise à jour d'un lien existant
DestinationurlStringObligatoire
SurnomnameString
RemarquesnoteString
Balises de retargeting (région head)head_tagsStringPour les pixels de retargeting
Balises de retargeting (région body)body_tagsStringPour les pixels de retargeting
Transférer les paramètresforward_paramsBoolean
Masquer le référenthide_referrerBooleanEnvoie referrer-policy: no-referrer pour que la destination ne voie pas Linkly dans l'en-tête referer
CamouflagecloakingBooleanMasque l'URL de destination derrière une frame
Bloquer les botsblock_botsBooleanBloque les bots/crawlers connus
Ignorer le suivi des crawlers sociauxskip_social_crawler_trackingBooleanQuand block_bots est activé, laissez quand même passer les crawlers sociaux pour que les aperçus OG fonctionnent
Analytiques publiquespublic_analyticsBooleanActive la page publique /abc123.stats pour ce lien
Mot de passepasswordStringLes visiteurs doivent entrer ce mot de passe avant la redirection
État de publicationenabledBoolean
Source UTMutm_sourceStringPour le suivi UTM
Moyen UTMutm_mediumStringPour le suivi UTM
Campagne UTMutm_campaignStringPour le suivi UTM
Terme UTMutm_termStringPour le suivi UTM
Contenu UTMutm_contentStringPour le suivi UTM
Domaine personnalisédomainStringObligatoire si slug est fourni. Voir domaines personnalisés
Suffixe de domaine personnaliséslugStringSi un domaine est fourni et slug est null, il sera auto-généré
Titre Open Graphog_titleStringPour les aperçus de médias sociaux
Description Open Graphog_descriptionStringPour les aperçus de médias sociaux
URL de l'image Open Graphog_imageStringPour les aperçus de médias sociaux
ID Meta Pixelfb_pixel_idStringPour Meta Pixel
ID TikTok Pixeltiktok_pixel_idString
ID Google Analytics 4ga4_tag_idString
Conteneur Google Tag Managergtm_idString
Mots à linklifierlinkify_wordsStringPhrases séparées par des retours à la ligne qui doivent être auto-raccourcies sur les pages de destination
RemplacementsreplacementsStringRègles de remplacement de texte appliquées à la page de destination
Date/heure d'expirationexpiry_datetimeISO8601 DateTime StringPour les liens expirant
Destination d'expirationexpiry_destinationString (URL)Pour les liens expirant. Doit commencer par http.
Clics d'expirationexpiry_clicksIntegerExpire le lien après ce nombre de clics
WebhookswebhooksArray of stringsURLs de webhook par lien. Voir webhooks.
Notifier les ID utilisateurnotify_user_idsArray of integersIDs d'utilisateur de l'espace de travail à notifier à chaque clic
Styles de code QRqr_stylesJSON objectPour le style de code QR. Clés : fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RèglesrulesJSON arrayPour les rotateurs, les redirections géo, et les redirections d'appareil

Exemple de demande utilisant curl

Le code ci-dessous illustre comment faire une demande API pour créer un lien.

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'

Une réponse réussie retournera un objet JSON représentant le lien, ainsi qu'un ID de lien.

{
    "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
}

Mise à jour d'un lien

Afin de mettre à jour un lien, envoyez la même demande que celle utilisée pour créer le lien, mais incluez le champ id pour le lien que vous souhaitez mettre à jour, ainsi que les modifications.

Créer des rotateurs via API

Afin de créer un rotateur, soumettez un champ appelé rules comme un tableau JSON, ainsi que la charge utile de lien ci-dessus. Vous devez utiliser application/json pour envoyer les tableaux JSON.

Par exemple :

[
  {"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
  {"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]

Créer des redirections géo via API

Afin de rediriger par pays, soumettez un champ appelé rules comme un tableau JSON, ainsi que la charge utile de lien ci-dessus. Vous devez utiliser l'encodage application/json pour envoyer les tableaux JSON.

Par exemple :

[
  {"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
  {"what": "country", "url": "https://www.apple.com", "matches": "US"}
]

Le pays est le code pays ISO 3166 alpha-2.

Créer des redirections d'appareil via API

Afin de rediriger par appareil, soumettez un champ appelé rules comme un tableau JSON, ainsi que la charge utile de lien ci-dessus.

Par exemple :

[
  {"what": "platform", "url": "https://www.google.com", "matches": "windows"},
  {"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]

Où le champ matches est l'un de :

  • ios
  • android
  • windows
  • linux
  • mac

Créer ou mettre à jour plusieurs liens en une seule demande

Linkly supporte la création/modification de jusqu'à 1000 liens par demande.

Pour ce faire, soumettez votre clé API dans le cadre de la demande comme suit :

https://app.linklyhq.com/api/v1/links?api_key=XXXXXXXXXXX

Ensuite, utilisez le même schéma que ci-dessus pour les cas de liens individuels, mais enveloppez les demandes de lien dans un tableau, de la forme :

[{link}, {link}]

Voici une demande complète qui mettra à jour deux liens :

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'

Cela fonctionne à la fois pour les actions de création et de mise à jour.

Veuillez noter que cela peut prendre jusqu'à 60 secondes pour une demande volumineuse. Si les demandes prennent plus de temps, elles échoueront et vous devriez envisager de diviser votre charge de travail en morceaux plus petits.

Limites de débit

L'API de raccourcissement de liens est limitée à 20 demandes/seconde. Jusqu'à 200 demandes par seconde sont disponibles sur demande. Vous pouvez télécharger jusqu'à 1000 liens en une seule demande.

Connexe

Disponibilité du forfait

Inclus sur tous les forfaits

Comparer les forfaits →

Obtenez 100 liens courts et suivez 500 clics mensuels gratuitement.