API de raccourcissement de liens de Linkly

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

Connexe : API d'analyse | Webhooks

Avant de commencer

Linkly génère les requêtes 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 requêtes API de création de liens.
  2. 2
    Copiez les requêtes dans leur intégralité. Vous pouvez vérifier qu'elles fonctionnent pour vous.
  3. 3
    Demandez à ChatGPT ou équivalent d'adapter ces requêtes 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 requêtes API directement à partir de l'interface utilisateur de Linkly.

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

L'API de raccourcissement de liens de Linkly construit automatiquement des requêtes 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 en utilisant 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 depuis 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 suffit d'envoyer une requête 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_keyStringRequis
ID de l'espace de travailworkspace_idIntegerRequis
ID du lienidIntegerRequis si mise à jour du lien existant
DestinationurlStringRequis
SurnomnameString
NotesnoteString
MétadonnéesmetadataObjectVos propres données clé-valeur, telles que les identifiants de votre système. Voir métadonnées
Balises de retargeting (région head)head_tagsStringPour pixels de retargeting
Balises de retargeting (région body)body_tagsStringPour pixels de retargeting
Paramètres avantforward_paramsBoolean
Masquer le référenthide_referrerBooleanEnvoie referrer-policy: no-referrer pour que la destination ne voie pas Linkly dans l'en-tête referrer
MasquagecloakingBooleanMasque l'URL de destination derrière une frame
Bloquer les botsblock_botsBooleanBloque les bots/crawlers connus
Ignorer le suivi des crawlers sociauxskip_social_crawler_trackingBooleanLorsque block_bots est activé, laissez passer les crawlers sociaux pour que les aperçus OG fonctionnent
Analyse publiquepublic_analyticsBooleanActive la page publique /abc123.stats pour ce lien
Mot de passepasswordStringLes visiteurs doivent entrer ce mot de passe avant la redirection
Statut de publicationenabledBoolean
Source UTMutm_sourceStringPour suivi UTM
Moyen UTMutm_mediumStringPour suivi UTM
Campagne UTMutm_campaignStringPour suivi UTM
Terme UTMutm_termStringPour suivi UTM
Contenu UTMutm_contentStringPour suivi UTM
Domaine personnalisédomainStringRequis si slug est fourni. Voir domaines personnalisés
Suffixe de domaine personnaliséslugStringSi domain est fourni et slug est null, sera généré automatiquement
Titre Open Graphog_titleStringPour aperçus sur les réseaux sociaux
Description Open Graphog_descriptionStringPour aperçus sur les réseaux sociaux
URL d'image Open Graphog_imageStringPour aperçus sur les réseaux 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 de Linkifylinkify_wordsStringPhrases séparées par des sauts de ligne qui doivent être automatiquement 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 liens expirants
Destination d'expirationexpiry_destinationString (URL)Pour liens expirants. Doit commencer par http.
Clics d'expirationexpiry_clicksIntegerExpirer 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'utilisateurs de l'espace de travail à notifier à chaque clic
Styles de code QRqr_stylesJSON objectPour style de code QR. Clés : fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RèglesrulesJSON arrayPour rotateurs, redirections géographiques, et redirections d'appareil

Exemple de requête utilisant curl

Le code ci-dessous illustre comment faire une requête 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 renverra 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,
    "metadata": {},
    "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
}

Mettre à jour un lien

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

Attacher vos propres données à un lien (métadonnées)

Utilisez metadata pour stocker vos propres identifiants par rapport à un lien, tels qu'un numéro de commande, un identifiant de contact CRM ou une référence de campagne de votre propre système. C'est un ensemble de paires clé-valeur, et il revient chaque fois que vous récupérez le lien et dans chaque charge utile webhook (événements de clic et de lien), afin que vous puissiez faire correspondre un clic à l'enregistrement auquel il appartient.

Envoyez-le dans un corps de requête JSON, en tant qu'objet :

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'Content-Type: application/json'
-d '{"api_key": "your_secret_key", "workspace_id": 1, "url": "https://example.com", "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}}'

Le lien dans la réponse inclut "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}.

Fonctionnement :

  • Les mises à jour sont fusionnées. Lorsque vous mettez à jour un lien, les clés que vous envoyez sont ajoutées aux métadonnées existantes du lien, et les clés que vous ne mentionnez pas restent inchangées. Pour supprimer une clé, définissez-la sur null (par exemple {"metadata": {"order_id": null}}).
  • Les valeurs sont des chaînes. Les nombres et les booléens sont stockés sous forme de texte, donc 42 revient sous forme de "42". Les objets imbriqués et les tableaux ne sont pas autorisés.
  • Limites. Jusqu'à 20 clés par lien, clés jusqu'à 40 caractères et valeurs jusqu'à 500 caractères, suffisant pour un UUID.
  • Privé pour vous. Les métadonnées ne sont jamais affichées aux personnes qui cliquent sur le lien, ne sont pas utilisées pour construire la redirection, et ne sont pas ajoutées à l'URL de destination.
  • Dans l'application. Vous pouvez également afficher et modifier les métadonnées dans les paramètres Automation d'un lien, sous Metadata.

Métadonnées, notes et paramètres UTM

Les métadonnées, le champ note et les paramètres UTM décrivent tous un lien, mais ils font des travaux différents :

  • Metadata est des données structurées clé-valeur pour vos propres systèmes. Elles sont renvoyées par l'API et envoyées dans les webhooks, le logiciel peut donc les lire.
  • Note est un champ de texte libre unique pour qu'une personne la lise dans l'application.
  • Les paramètres UTM sont ajoutés à l'URL de destination, afin que la page vers laquelle vous envoyez les visiteurs et son analyse puissent les voir. Les métadonnées ne le sont jamais. Pour transmettre une valeur à la page de destination, utilisez un paramètre UTM, ou activez Transfert des paramètres pour que les paramètres de requête sur le lien court soient transmis.

Métadonnées et analyse

Les métadonnées ne sont pas incluses dans l'analyse des clics ou les exportations de clics, et vous ne pouvez pas regrouper ou filtrer les clics, ou rechercher des liens, par métadonnées. Pour lier les clics à vos propres enregistrements, utilisez l'id du lien. Il apparaît dans les charges utiles webhook, dans les analyses ventilées par lien et dans les réponses de lien. Cherchez votre enregistrement à partir de l'id du lien de votre côté, ou récupérez le lien pour lire ses métadonnées.

Création de rotateurs via API

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

Par exemple :

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

Création de redirections géographiques via API

Pour rediriger par pays, soumettez un champ appelé rules en tant que tableau JSON, ainsi que la charge utile de lien ci-dessus. Vous devez utiliser l'encodage application/json pour envoyer des 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éation de redirections d'appareil via API

Pour rediriger par appareil, soumettez un champ appelé rules en tant que 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 des :

  • ios
  • android
  • windows
  • linux
  • mac

Création ou mise à jour de plusieurs liens dans une seule requête

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

Pour ce faire, soumettez votre clé API dans le cadre de la requête 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 requêtes de lien dans un tableau, de la forme :

[{link}, {link}]

Voici une requête 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 pour les actions de création et de mise à jour.

Veuillez noter que les grandes requêtes peuvent prendre jusqu'à 60 secondes. Si les requêtes prennent plus de temps, elles échoueront, et vous devriez envisager de diviser votre charge de travail en petits morceaux.

Limites de débit

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

Connexe

Disponibilité du forfait

Inclus sur tous les forfaits

Comparer les forfaits →

Obtenez 100 liens courts et suivez 500 clics mensuels gratuitement.