Skip to main content
GET
README de l’app
GET https://api-datahub.octoparse.com/v1/data-apps/{app_id}/readme Authentification : facultative. Avec une clé API vous pouvez voir des apps qui exigent une vue connectée. Texte enrichi orienté humain (Markdown brut). Il ne fait pas partie de la charge de détail lisible par machine et se récupère à la demande. Par défaut, la dernière version.

Requête

Paramètres de chemin

string
requis
Référence d’app : app_<hex> ou <namespace>/<app_name>.

Paramètres de requête

string
Version à lire. Par défaut, la plus récente.

Exemple de requête

Réponse

200 succès

Le corps est du text/markdown brut, sans enveloppe. Les apps sans README renvoient un corps vide.

Erreurs

Les réponses d’erreur utilisent {"error": {code, category, message, retryable}}. Voir Erreurs.

Bibliothèques clientes

Les SDK Python et JavaScript n’encapsulent pas encore cet endpoint. Appelez REST directement.