API de raccourcissement de liens Linkly

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

Associé : API Analytics | Webhooks

Avant de commencer

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

Ceci fonctionne pour la création de lien et la mise à jour de lien.

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

  1. 1
    Voir ci-dessous pour les requêtes API de création de lien.
  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 requêtes 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 des requêtes 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 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 selon la norme OpenAPI, ce 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.

Afficher la spécification OpenAPI

Exécuter dans Postman

Autorisation

Vous aurez besoin de :

  • Votre clé API
  • ID du workspace

Vous pouvez obtenir ces informations à 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 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 du workspaceworkspace_idIntegerRequis
ID du lienidIntegerRequis si mise à jour du lien existant
DestinationurlStringRequis
SurnomnameString
NotesnoteString
Tags de retargeting (région head)head_tagsStringPour pixels de retargeting
Tags de retargeting (région body)body_tagsStringPour pixels de retargeting
Transférer les paramètresforward_paramsBoolean
Masquer le référenthide_referrerBooleanEnvoie referrer-policy: no-referrer de sorte que la destination ne voit pas Linkly dans l'en-tête du référent
DissimulationcloakingBooleanMasque l'URL de destination derrière un cadre
Bloquer les robotsblock_botsBooleanBloque les bots/crawlers connus
Ignorer le suivi des robots sociauxskip_social_crawler_trackingBooleanQuand block_bots est activé, laissez quand même passer les robots des réseaux sociaux pour que les aperçus OG fonctionnent
Analytique publiquepublic_analyticsBooleanActivez la page /abc123.stats publique pour ce lien
Mot de passepasswordStringLes visiteurs doivent entrer ce mot de passe avant la redirection
État 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 le domaine est fourni et le slug est nul, il sera auto-généré
Titre Open Graphog_titleStringPour aperçus de médias sociaux
Description Open Graphog_descriptionStringPour aperçus de médias sociaux
URL de l'image Open Graphog_imageStringPour aperçus de médias sociaux
ID Pixel Metafb_pixel_idStringPour Meta Pixel
ID Pixel TikToktiktok_pixel_idString
ID Google Analytics 4ga4_tag_idString
Conteneur Google Tag Managergtm_idString
Mots Linkifylinkify_wordsStringPhrases séparées par des sauts de ligne qui doivent être auto-raccourcies sur les pages de destination
RemplacementsreplacementsStringRègles de remplacement de texte appliquées à la page de destination
DateTime d'expirationexpiry_datetimeChaîne DateTime ISO8601Pour liens d'expiration
Destination d'expirationexpiry_destinationString (URL)Pour liens d'expiration. Doit commencer par http.
Clics d'expirationexpiry_clicksIntegerExpirer 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'utilisateurs du workspace à notifier à chaque clic
Styles de code QRqr_stylesObjet JSONPour styles de code QR. Clés : fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RèglesrulesTableau JSONPour rotateurs, redirections géographiques, et redirections d'appareil

Exemple de requête avec 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 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 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.

Création de rotateurs via API

Pour créer un rotateur, soumettez un champ appelé rules sous forme de tableau JSON, ainsi que la charge utile du 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 sous forme de tableau JSON, ainsi que la charge utile du 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 de pays ISO 3166 alpha-2.

Création de redirections d'appareil via API

Pour rediriger par appareil, soumettez un champ appelé rules sous forme de 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 :

  • ios
  • android
  • windows
  • linux
  • mac

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

Linkly prend en charge la création/amendement de jusqu'à 1000 liens par requête.

Pour ce faire, soumettez votre clé API comme partie de la requête 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 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/workspace/WORKSPACE_ID/links?api_key=API_KEY'

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

Veuillez noter que cela peut prendre jusqu'à 60 secondes pour une grande requête. Si les requêtes prennent plus de temps que cela, 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é à 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.

Associé

Disponibilité du forfait

Inclus sur tous les forfaits

Comparer les forfaits →

Obtenez 100 liens courts et suivez 500 clics mensuels gratuitement.