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 :
- 1Voir ci-dessous pour les requêtes API de création de lien.
- 2Copiez les demandes dans leur intégralité. Vous pouvez vérifier qu'elles fonctionnent pour vous.
- 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 à 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
Autorisation
Vous aurez besoin de :
- Votre clé API
- ID du workspace
Vous pouvez obtenir ces informations à partir de Linkly.
- 1Connectez-vous à Linkly.
- 2Cliquez sur Paramètres.
- 3Cliquez 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.
| Étiquette | Clé | Type | Notes |
|---|---|---|---|
| Clé API du compte | api_key | String | Requis |
| ID du workspace | workspace_id | Integer | Requis |
| ID du lien | id | Integer | Requis si mise à jour du lien existant |
| Destination | url | String | Requis |
| Surnom | name | String | |
| Notes | note | String | |
| Tags de retargeting (région head) | head_tags | String | Pour pixels de retargeting |
| Tags de retargeting (région body) | body_tags | String | Pour pixels de retargeting |
| Transférer les paramètres | forward_params | Boolean | |
| Masquer le référent | hide_referrer | Boolean | Envoie referrer-policy: no-referrer de sorte que la destination ne voit pas Linkly dans l'en-tête du référent |
| Dissimulation | cloaking | Boolean | Masque l'URL de destination derrière un cadre |
| Bloquer les robots | block_bots | Boolean | Bloque les bots/crawlers connus |
| Ignorer le suivi des robots sociaux | skip_social_crawler_tracking | Boolean | Quand block_bots est activé, laissez quand même passer les robots des réseaux sociaux pour que les aperçus OG fonctionnent |
| Analytique publique | public_analytics | Boolean | Activez la page /abc123.stats publique pour ce lien |
| Mot de passe | password | String | Les visiteurs doivent entrer ce mot de passe avant la redirection |
| État de publication | enabled | Boolean | |
| Source UTM | utm_source | String | Pour suivi UTM |
| Moyen UTM | utm_medium | String | Pour suivi UTM |
| Campagne UTM | utm_campaign | String | Pour suivi UTM |
| Terme UTM | utm_term | String | Pour suivi UTM |
| Contenu UTM | utm_content | String | Pour suivi UTM |
| Domaine personnalisé | domain | String | Requis si slug est fourni. Voir domaines personnalisés |
| Suffixe de domaine personnalisé | slug | String | Si le domaine est fourni et le slug est nul, il sera auto-généré |
| Titre Open Graph | og_title | String | Pour aperçus de médias sociaux |
| Description Open Graph | og_description | String | Pour aperçus de médias sociaux |
| URL de l'image Open Graph | og_image | String | Pour aperçus de médias sociaux |
| ID Pixel Meta | fb_pixel_id | String | Pour Meta Pixel |
| ID Pixel TikTok | tiktok_pixel_id | String | |
| ID Google Analytics 4 | ga4_tag_id | String | |
| Conteneur Google Tag Manager | gtm_id | String | |
| Mots Linkify | linkify_words | String | Phrases séparées par des sauts de ligne qui doivent être auto-raccourcies sur les pages de destination |
| Remplacements | replacements | String | Règles de remplacement de texte appliquées à la page de destination |
| DateTime d'expiration | expiry_datetime | Chaîne DateTime ISO8601 | Pour liens d'expiration |
| Destination d'expiration | expiry_destination | String (URL) | Pour liens d'expiration. Doit commencer par http. |
| Clics d'expiration | expiry_clicks | Integer | Expirer le lien après ce nombre de clics |
| Webhooks | webhooks | Tableau de chaînes | URLs de webhook par lien. Voir webhooks. |
| Notifier les ID d'utilisateur | notify_user_ids | Tableau d'entiers | ID d'utilisateurs du workspace à notifier à chaque clic |
| Styles de code QR | qr_styles | Objet JSON | Pour styles de code QR. Clés : fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Règles | rules | Tableau JSON | Pour 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é
- API Analytics - Exportez les données de clics et les rapports de trafic
- Webhooks - Notifications de clics en temps réel
- Intégration Zapier - Intégrations sans code
Disponibilité du forfait
Inclus sur tous les forfaits
Obtenez 100 liens courts et suivez 500 clics mensuels gratuitement.