Simple à lire
Consultez les endpoints, champs, exemples, erreurs et réponses sans lire le code du serveur.
Explorez toutes les opérations prises en charge par l’API URLZ, leurs paramètres, réponses et méthodes d’authentification dans une référence claire et exploitable par vos outils.
La description OpenAPI est le contrat technique entre URLZ et votre application. Elle permet de comprendre les requêtes, valider les réponses, importer l’API dans vos outils ou générer un client.
Consultez les endpoints, champs, exemples, erreurs et réponses sans lire le code du serveur.
Importez le JSON dans Postman, Insomnia, Swagger, Redocly ou un générateur de client API.
Chaque opération indique son authentification. Vos secrets doivent rester sur votre serveur.
Créez votre compte URLZ puis ouvrez la rubrique API de la dashboard.
Utilisez une clé API côté serveur ou une session Bearer pour les fonctions du compte.
Copiez un exemple, remplacez les valeurs fictives et envoyez-le en HTTPS.
Vérifiez d’abord le statut HTTP, puis lisez la réponse JSON documentée.
Recherchez dans la spécification, ouvrez une opération et consultez ses paramètres, son corps de requête, ses exemples et toutes les réponses possibles.