Skip to main content

Copier toute la documentation

Le fichier regroupe les guides et le contrat OpenAPI enrichi des 158 opérations stables, avec ses schémas référencés. Il est volumineux : pour une tâche ciblée, fournir seulement les pages utiles évite de saturer le contexte de votre assistant.

Copier une famille API ou un tutoriel

La sélection contient les guides utiles, l’authentification, les routes du périmètre choisi et tous leurs schémas référencés. Un tutoriel inclut les contrats des appels qu’il utilise. Le texte copié est autonome : aucun schéma nécessaire n’est remplacé par un lien vers une autre partie du contrat.

Copier une page

Le menu Copy page de chaque page permet de copier son Markdown, voir la version texte et l’ouvrir dans ChatGPT ou Claude. Les pages API contiennent le scope requis dans leur texte; les extensions x-marko-* du contrat ne sont pas le seul endroit où lire cette information. L’index des pages permet à un agent de découvrir la documentation. Les pages sont également disponibles en Markdown en ajoutant .md à leur URL. Le texte agrégé du site rassemble les guides et les descriptions des routes. Pour obtenir tous les schémas de requête et de réponse, utilisez la copie complète ci-dessus, le contrat OpenAPI enrichi ou les pages API individuelles.

Contrats machine

Le contrat enrichi contient x-documentation-provenance, qui identifie la version du backend utilisée pour les types et l’empreinte du catalogue public. Une référence documentée ne prouve pas que votre clé y a accès ni qu’une ressource d’exemple existe. Le téléchargement complet est un fichier JSON dont le champ markdown contient le texte à fournir à votre assistant. Le bouton de copie extrait directement ce texte pour le presse-papiers.

SDK et client généré

Pour démarrer avec un client JSON, utiliser les exemples Python, Node.js et PHP. Ils prennent en charge la signature HMAC et le renouvellement du bearer. Cette documentation ne fournit pas de SDK officiel MARKO. Vous pouvez générer un client à partir d’OpenAPI avec un générateur compatible OpenAPI 3.1, puis ajouter l’échange HMAC et la gestion des reprises. Le client HTTP doit prendre en charge les timeouts, application/problem+json, les fichiers multipart et les réponses binaires. Conservez les secrets dans l’environnement du serveur ou un gestionnaire de secrets. Les exemples sont synthétiques : remplacez leurs identifiants par ceux de votre contexte, sans les traiter comme des ressources de test disponibles.

Contexte utile pour un assistant