API publique & utilitaires (Server time, docs)
API publique & utilitaires
Heure serveur, documentation et outils de diagnostic
Accédez aux utilitaires publics pour synchroniser l’heure, explorer la documentation API depuis l’interface et lancer des aperçus/diagnostics utiles pour l’UI et les intégrations tierces.
Cette fonctionnalité fournit des outils accessibles depuis l’interface et depuis des intégrations externes pour : afficher l’heure exacte du serveur, consulter la documentation API depuis les paramètres, et exécuter des prévisualisations et diagnostics pour debug et vérification. Utile pour garder l’interface synchronisée, diagnostiquer des erreurs et intégrer des services externes.
Capacités clés
Heure serveur
Obtenir l’heure exacte du serveur en temps réel pour synchroniser les horodatages côté client (pratique pour planifier exécutions et afficher dates cohérentes).
Documentation API intégrée
Ouvrir la documentation depuis l’interface Paramètres > API Docs : exemples d’appels, méthodes d’authentification et codes d’erreur prêts à l’emploi.
Prévisualisations & diagnostics
Lancer des aperçus de documents et des outils de diagnostic depuis l’interface pour vérifier les filtres, le nombre de documents ou l’état des intégrations avant exécution. :
Routes publiques compatibles
Certaines routes publiques sont conçues pour être utilisées depuis l’extérieur (ex. site public) et acceptent les requêtes cross-origin pour faciliter les intégrations.
Feedback en temps réel
Affichage en direct d’informations utiles (compteurs, progression) dans l’interface pour suivre l’état des opérations déclenchées.
Aide au debugging
Points de diagnostic accessibles pour comprendre pourquoi une intégration ou une prévisualisation échoue, avec messages clairs pour corriger rapidement.
How to use it
Étapes principales
Consulter l'heure du serveur
- Ouvrez la boîte de configuration où vous planifiez une action (par ex. la fenêtre de création/édition d’un hook).
- Repérez la section intitulée “Heure du serveur” ou un bouton “Synchroniser l’heure”.
- Cliquez sur le bouton de rafraîchissement si présent ; l’interface affiche alors l’heure serveur actuelle dans le même format que votre champ de date/heure.
- Que se passe-t-il ensuite : l’heure affichée est utilisée pour calculer et envoyer un horodatage cohérent depuis l’interface (utile pour définir la prochaine exécution).
Accéder à la documentation API depuis l'interface
- Allez dans Paramètres > API Docs.
- Parcourez les sections : méthodes d’authentification, endpoints disponibles, exemples en cURL/JavaScript/Python et gestion des erreurs.
- Que faire : copiez un exemple d’appel, ajustez la clé d’authentification fournie dans l’exemple, et testez depuis votre outil favori (postman, terminal, etc.). La page contient aussi des exemples de headers d’authentification et de paramètres.
Prévisualiser des documents et lancer des diagnostics
- Dans une page où vous configurez des filtres de documents (ex. filtre d’entrée d’un hook), cherchez le bouton “Prévisualiser” ou “Aperçu des documents”.
- Cliquez sur ce bouton : l’interface envoie la requête de prévisualisation et affiche le nombre de documents correspondants ainsi qu’un aperçu sommaire.
- Si quelque chose ne correspond pas : utilisez la section de diagnostic (ou messages d’erreur à l’écran) pour voir quel filtre ou quelle source pose problème, puis ajustez les filtres et relancez l’aperçu.
Utiliser les routes publiques depuis un service externe
- Lorsque vous exposez une ressource publique (ex. site public), vérifiez que votre appel depuis un navigateur externe fonctionne.
- Dans vos tests externes, effectuez une requête depuis l’origine de votre application cliente et observez la réponse.
- Que vérifier : si la requête est bloquée, vérifiez les en-têtes CORS côté application (la route publique doit accepter les requêtes cross-origin pour que l’appel externe fonctionne).
Suivre la progression en temps réel
- Lors d’opérations longues (génération de documents, import de sources), regardez la barre/zone de progression dans l’interface projet.
- Si la page est rechargée, vous pouvez retrouver l’état précédent : l’interface essaie de restaurer la progression et de continuer les mises à jour.
- Si la progression ne bouge pas : utilisez l’outil de diagnostic pour demander l’état actuel et relancer la vérification.
Astuce pratique
Pour éviter des décalages d’horaire, appelez la fonction de synchronisation de l’heure au moment où vous ouvrez un formulaire de planification. L’interface rafraîchit automatiquement l’heure toutes les 60 secondes lorsque le dialogue est ouvert.
Limites et règles importantes
- L’heure fournie par le serveur est renvoyée en format ISO : utilisez ce format pour calculer des horodatages côté client (par exemple la valeur “next_execution_at”).
- Les routes destinées à un usage externe doivent accepter les requêtes cross-origin (CORS) pour que des services tiers ou un site public puissent les appeler depuis un navigateur. Si vos appels externes échouent, commencez par vérifier les règles CORS et l’origine de la requête.
- Certaines actions (prévisualisation, diagnostics) peuvent retourner des erreurs liées aux droits d’accès ou à des filtres invalides : vérifiez les messages affichés et ajustez les paramètres avant de relancer.
FAQ
Frequently Asked Questions
:::cta{title=“Besoin d’aide supplémentaire ?” buttonText=“Consulter la documentation complète” buttonLink=“/settings/api-docs” variant=“primary”} Toutes les étapes et exemples d’appels y sont détaillés pour accélérer vos intégrations. :::