API de raccourcissement de liens de Linkly

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

Connexe : API Analytics | Webhooks

Avant de commencer

Linkly génère les requêtes API dans l'interface pour vous les copier et coller dans vos applications.

Cela 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
    Consultez ci-dessous pour les requêtes API de création de lien.
  2. 2
    Copiez les requêtes 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 consacrer du temps à une intégration complexe. Notre API est entièrement consommable par machine.

Spécification OpenAPI 3.0

Vous pouvez générer les 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 crée automatiquement les 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 le code de 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 sous forme de collection Postman en un clic.

Afficher 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 dans 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 de compteapi_keyChaîneRequis
ID de l'espace de travailworkspace_idEntierRequis
ID de lienidEntierRequis pour la mise à jour du lien existant
DestinationurlChaîneRequis
SurnomnameChaîne
NotesnoteChaîne
Balises de retargeting (région head)head_tagsChaînePour pixels de retargeting
Balises de retargeting (région body)body_tagsChaînePour pixels de retargeting
Transférer les paramètresforward_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 de referer
MasquagecloakingBooléenMasque l'URL de destination derrière un cadre
Bloquer les botsblock_botsBooléenBloque les bots/crawlers connus
Ignorer le suivi du crawler socialskip_social_crawler_trackingBooléenQuand block_bots est activé, laissez quand même les crawlers sociaux passer pour que les aperçus OG fonctionnent
Analyse publiquepublic_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îneRequis si un slug est fourni. Voir domaines personnalisés
Suffixe de domaine personnaliséslugChaîneSi un domaine est fourni et que slug est null, il 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 de pixel Metafb_pixel_idChaînePour Meta Pixel
ID de pixel TikToktiktok_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 raccourcies automatiquement sur les pages de destination
RemplacementsreplacementsChaîneRègles de remplacement de texte appliquées à la page de destination
Date/heure d'expirationexpiry_datetimeChaîne date/heure ISO8601Pour les liens expirants
Destination d'expirationexpiry_destinationChaîne (URL)Pour les liens expirants. Doit commencer par http.
Clics d'expirationexpiry_clicksEntierFaire expirer 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'entiersIDs d'utilisateur de l'espace de travail à notifier à chaque clic
Styles de code QRqr_stylesObjet JSONPour le stylage du code QR. Clés : fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RèglesrulesTableau JSONPour les rotateurs, les redirections géographiques et les redirections d'appareils

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 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 vous utiliseriez pour créer un lien, mais incluez le champ id du lien que vous souhaitez mettre à jour, ainsi que les modifications.

Créer des rotateurs via l'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éer des redirections géographiques via l'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 de pays alpha-2 ISO 3166.

Créer des redirections d'appareils via l'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 éléments suivants :

  • ios
  • android
  • windows
  • linux
  • mac

Créer ou mettre à jour plusieurs liens dans une seule requête

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

Pour ce faire, soumettez votre clé API dans 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'

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

Veuillez noter qu'il peut falloir jusqu'à 60 secondes pour une requête volumineuse. 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ée à 20 requêtes/seconde. Jusqu'à 200 requêtes/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.