API de raccourcissement de liens de Linkly

Créez, mettez à jour et gérez des liens de manière programmatique en utilisant l'API de raccourcissement de liens de Linkly.

Connexe : API Analytics | Webhooks

Avant de commencer

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

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

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

  1. 1Voir ci-dessous pour les requêtes API de création de liens.
  2. 2Copiez les requêtes dans leur intégralité. Vous pouvez vérifier qu'elles fonctionnent pour vous.
  3. 3Demandez à 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 depuis l'interface utilisateur de Linkly.

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

L'API de raccourcissement de liens de Linkly génère automatiquement des requêtes API en fonction du contenu du formulaire. Vous pouvez coller le texte donné 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.

Autorisation

Vous aurez besoin de :

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

Vous pouvez obtenir ces détails depuis Linkly.

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

Créer ou mettre à jour un lien

Pour créer un lien, tout ce que vous avez à faire est 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.

LibelléCléTypeNotes
Clé API du compteapi_keyStringRequis
ID de l'espace de travailworkspace_idIntegerRequis
ID du lienidIntegerRequis si mise à jour d'un lien existant
DestinationurlStringRequis
SurnomnameString
NotesnoteString
Balises de reciblage (région head)head_tagsStringPour pixels de reciblage
Balises de reciblage (région body)body_tagsStringPour pixels de reciblage
Transférer les paramètresforward_paramsBoolean
Statut de publicationenabledBoolean
UTM Sourceutm_sourceStringPour suivi UTM
UTM Mediumutm_mediumStringPour suivi UTM
UTM Campaignutm_campaignStringPour suivi UTM
UTM Termutm_termStringPour suivi UTM
UTM Contentutm_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 de réseaux sociaux
Description Open Graphog_descriptionStringPour aperçus de réseaux sociaux
URL d'image Open Graphog_imageStringPour aperçus de réseaux sociaux
ID Meta Pixelfb_pixel_idStringPour Meta Pixel
ID Google Analytics 4ga4_tag_idString
Conteneur Google Tag Managergtm_idString
Date et heure d'expirationexpiry_datetimeISO8601 DateTime StringPour liens expirants
Destination d'expirationexpiry_destinationStringPour liens expirants
RèglesrulesJSON arrayPour rotateurs, redirections géographiques et redirections par appareil

Exemple de requête utilisant cURL

Le code ci-dessous illustre comment effectuer 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,
    "alias": null,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "enabled": true,
    "cloaking": false,
    "replacements": 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,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "block_bots": false,
    "rules": [],
    "workspace_id": 1448,
    "referer_mode": null,
    "custom_referer": null,
    "click_fraud_mode": null,
    "deleted": false
}

Mettre à jour un lien

Pour mettre à jour un lien, envoyez la même requête 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éer des rotateurs via l'API

Pour créer un rotateur, soumettez un champ appelé rules comme un tableau JSON, avec 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éer des redirections géographiques via l'API

Pour rediriger par pays, soumettez un champ appelé rules comme un tableau JSON, avec 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 pays alpha-2 ISO 3166.

Créer des redirections par appareil via l'API

Pour rediriger par appareil, soumettez un champ appelé rules comme un tableau JSON, avec 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éer ou mettre à jour plusieurs liens en une seule requête

Linkly prend en charge la création/modification 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 liens 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 pour les actions de création et de mise à jour.

Veuillez noter qu'une requête volumineuse peut prendre jusqu'à 60 secondes. 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 par seconde sont disponibles sur demande. Vous pouvez télécharger jusqu'à 1000 liens en une seule requête.

Connexe

Track 1000 monthly clicks with all features included.

No credit card required