API de raccourcissement de liens Linkly

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

Connexes : API Analytics | Webhooks

Avant de commencer

Linkly génère les demandes d'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.

Économisez du temps et laissez-nous faire le travail difficile :

  1. 1
    Voir ci-dessous pour les demandes d'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 équivalent d'adapter ces demandes en code source pour votre application. Il n'est pas nécessaire de passer du temps à faire une intégration complexe. Notre API est entièrement consommable par machine.

Spécification OpenAPI 3.0

Vous pouvez générer les demandes d'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 construit automatiquement les demandes d'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 à l'aide de 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 à l'intérieur 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 envoyez le champ Rules, vous devez utiliser application/json.

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

ÉtiquetteCléTypeRemarques
Clé API du compteapi_keyChaîneObligatoire
ID de l'espace de travailworkspace_idEntierObligatoire
ID du lienidEntierObligatoire si mise à jour d'un lien existant
DestinationurlChaîneObligatoire
SurnomnameChaîne
NotesnoteChaîne
Tags de retargeting (région head)head_tagsChaînePour les pixels de retargeting
Tags de retargeting (région body)body_tagsChaînePour les pixels de retargeting
Paramètres directsforward_paramsBooléen
Masquer le référenthide_referrerBooléenEnvoie referrer-policy: no-referrer pour que la destination ne voie pas Linkly dans l'en-tête referer
MasquagecloakingBooléenMasque l'URL de destination derrière un cadre
Bloquer les botsblock_botsBooléenBloque les bots/crawlers connus
Ignorer le suivi des robots sociauxskip_social_crawler_trackingBooléenQuand block_bots est activé, laissez quand même les crawlers sociaux passer pour que les aperçus OG fonctionnent
Analyses publiquespublic_analyticsBooléenActive la page publique /abc123.stats pour ce lien
Mot de passepasswordChaîneLes visiteurs doivent entrer ce mot de passe avant la redirection
Statut de publicationenabledBooléen
Source UTMutm_sourceChaînePour le suivi UTM
Moyen UTMutm_mediumChaînePour le suivi UTM
Campagne UTMutm_campaignChaînePour le suivi UTM
Terme UTMutm_termChaînePour le suivi UTM
Contenu UTMutm_contentChaînePour le suivi UTM
Domaine personnalisédomainChaîneObligatoire si le slug est fourni. Voir les domaines personnalisés
Suffixe de domaine personnaliséslugChaîneSi le domaine est fourni et le slug est nul, sera généré automatiquement
Titre Open Graphog_titleChaînePour les aperçus sur les réseaux sociaux
Description Open Graphog_descriptionChaînePour les aperçus sur les réseaux sociaux
URL de l'image Open Graphog_imageChaînePour les aperçus sur les réseaux sociaux
ID Meta Pixelfb_pixel_idChaînePour Meta Pixel
ID TikTok Pixeltiktok_pixel_idChaîne
ID Google Analytics 4ga4_tag_idChaîne
Conteneur Google Tag Managergtm_idChaîne
Linkifier les motslinkify_wordsChaînePhrases séparées par des sauts de ligne qui doivent être auto-raccourcies sur les pages de destination
RemplacementsreplacementsChaîneRègles de remplacement de texte appliquées à la page de destination
DateTime d'expirationexpiry_datetimeChaîne ISO8601 DateTimePour les liens d'expiration
Destination d'expirationexpiry_destinationChaîne (URL)Pour les liens d'expiration. Doit commencer par http.
Clics d'expirationexpiry_clicksEntierExpirer le lien après ce nombre de clics
WebhookswebhooksTableau de chaînesURLs de webhook par lien. Voir webhooks.
Notifier les ID d'utilisateurnotify_user_idsTableau d'entiersID d'utilisateur de l'espace de travail à notifier à chaque clic
Styles de code QRqr_stylesObjet JSONPour la mise en style des codes QR. Clés : fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RèglesrulesTableau JSONPour les rotateurs, redirections géo, et redirections d'appareil

Exemple de demande utilisant cURL

Le code ci-dessous illustre comment faire une demande d'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

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

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 du 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éation de redirections géo via API

Pour rediriger par pays, soumettez un champ appelé rules en tant que tableau JSON, ainsi que la charge utile du 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é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 du 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 suivants :

  • ios
  • android
  • windows
  • linux
  • mac

Création ou mise à jour de plusieurs liens en une seule demande

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

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

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

Ensuite, utilisez le même schéma que ci-dessus pour les cas individuels de liens, mais enveloppez les demandes de liens 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/workspace/WORKSPACE_ID/links?api_key=API_KEY'

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

Veuillez noter que cela peut prendre jusqu'à 60 secondes pour une demande importante. Si les demandes prennent plus longtemps, elles échoueront et vous devriez envisager de diviser votre charge de travail en chunks 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 dans une seule demande.

Connexes

Disponibilité du forfait

Inclus sur tous les forfaits

Comparer les forfaits →

Obtenez 100 liens courts et suivez 500 clics mensuels gratuitement.