Disponible avec la formule « Marketer » et les formules supérieures.
Cette page offre une présentation générale. La documentation complète et toujours à jour de l'API REST se trouve dans votre interface d'administration WordPress. — aller à Tableau de bord > Pretty Links > Outils de développement > Documentation pour consulter des exemples complets de requêtes et de réponses.
Ce guide fait partie de la Présentation de l'extension « Pretty Links Developer Tools », la page d'accueil de l'extension « Developer Tools ».
Où trouver la référence complète
Dans la barre latérale d'administration de WordPress, rendez-vous dans Tableau de bord > Pretty Links > Outils de développement > Documentation.
L'onglet « Docs » affiche chaque point de terminaison avec sa méthode HTTP, ses paramètres, le format du corps de la requête, le format de la réponse et des exemples d'appels. Comme il est hébergé au sein de votre installation, il correspond toujours à la version actuelle de Pretty Links — vous n'avez donc pas à vous soucier de documents en ligne obsolètes.
Ouvrez l'onglet « Docs » dans un deuxième onglet de navigateur pendant que vous travaillez. C'est la source de référence.
Présentation des terminaux
Voici un aperçu rapide des fonctionnalités disponibles, pour que vous sachiez ce qui est possible avant de vous plonger dans la documentation de l'application.
Pretty Links (CRUD)
- Liste des liens esthétiques — Accédez à tous vos « Pretty Links », avec des options de filtrage et de pagination ;
- Obtenir un seul Pretty Link — Rechercher un lien à l'aide de son identifiant ;
- Créer un « Pretty Link » — Ajouter un nouveau lien par programmation. Utile pour les migrations, les importations en masse ou la création automatique de liens à partir d'un autre système ;
- Mettre à jour un « Pretty Link » — Modifier l'URL de destination, le slug, le type de redirection, le nom ou d'autres champs d'un lien existant ;
- Supprimer un « Pretty Link » — Mettre à la corbeille ou supprimer définitivement un lien.
Abonnements aux webhooks
- S'abonner — Créer un nouvel abonnement à un webhook par programmation (POST) ;
- Se désabonner — Supprimer un abonnement à un webhook par ID (DELETE).
Ces fonctionnalités sont utiles lorsqu'un système externe doit gérer lui-même le cycle de vie de ses abonnements aux webhooks — par exemple, une intégration qui souhaite s'enregistrer automatiquement lorsqu'elle est activée et se désenregistrer lorsqu'elle est désactivée. Pour consulter la liste actuelle des abonnements, utilisez l'écran « Webhooks » dans l'interface d'administration.
Authentification
Tous les points de terminaison nécessitent la clé API du site, transmise soit dans le PRLI-API-KEY en-tête ou le Autorisation en-tête. Voir Clés API pour savoir où le trouver et comment le régénérer.
L'espace de noms REST est pl/v1 — par exemple, https://yoursite.com/wp-json/pl/v1/links.
L'onglet « Docs » de l'application affiche le format exact de l'en-tête ainsi qu'un exemple de commande curl que vous pouvez copier.
Format de réponse
Toutes les réponses sont au format JSON. Les réponses réussies renvoient un code d'état 2xx, avec les données correspondantes dans le corps de la réponse. Les erreurs renvoient un code d'état 4xx ou 5xx, avec un corps de réponse au format JSON décrivant la nature du problème.
Les conventions HTTP standard s'appliquent :
200 OK— Lecture réussie ;201 Créé— Création réussie ;400 Erreur de requête— Votre requête n'était pas valide ;401 Accès non autorisé— Clé API manquante ou non valide ;404 Page introuvable— Le lien ou la ressource n'existe pas ;Erreur 500 du serveur interne— Une erreur s'est produite sur le serveur.
Conseils d'utilisation de l'API
Commencez par un appel à la fonction « List ». La première requête à tester est “ lister tous mes Pretty Links ”. Elle permet de vérifier votre clé API, le format de vos URL et la configuration de votre outil, le tout en une seule fois.
Consultez la documentation intégrée à l'application pour connaître les noms exacts des champs. La liste des champs d'un « Pretty Link » est documentée dans l'interface d'administration. Ne devinez pas les noms des champs ; copiez-les directement depuis la documentation pour éviter les fautes de frappe.
Testez d'abord les appels de création et de mise à jour sur un site de préproduction. Une faute de frappe dans un script de création en masse peut générer des centaines de liens erronés. Testez-le d'abord sur un environnement de préproduction, vérifiez le résultat, puis appliquez-le à l'environnement de production.
Utilisez des webhooks plutôt que l'interrogation régulière. Si vous vous retrouvez à interroger régulièrement le point de terminaison « List » pour vérifier s'il y a eu des modifications, configurez plutôt un abonnement via webhook. Vous recevrez ainsi les modifications en temps réel, sans vous soucier des limites de fréquence.
Si un webhook ne se déclenche pas, consultez le journal des événements. Ne vous fiez pas à vos suppositions : vérifiez. Le journal des événements indique si Pretty Links a bien envoyé la requête et quelle réponse votre point de terminaison a renvoyée.
Pour tout le reste, l'onglet « Docs » de l'application est la référence absolue. Ajoutez-le à vos favoris.