Skip to main content
GET
README de la app
GET https://api-datahub.octoparse.com/v1/data-apps/{app_id}/readme Autenticación: opcional. Con una API key puede ver apps que requieren una vista con sesión iniciada. Texto enriquecido orientado a humanos (Markdown en bruto). No forma parte de la carga de detalle legible por máquina y se obtiene bajo demanda. Por defecto usa la versión más reciente.

Solicitud

Parámetros de ruta

string
requerido
Referencia de app: app_<hex> o <namespace>/<app_name>.

Parámetros de consulta

string
Versión a leer. Por defecto, la más reciente.

Ejemplo de solicitud

Respuesta

200 correcto

El cuerpo es text/markdown en bruto, sin sobre. Las apps sin README devuelven un cuerpo vacío.

Errores

Las respuestas de error usan {"error": {code, category, message, retryable}}. Ver Errores.

Bibliotecas cliente

Los SDK de Python y JavaScript aún no encapsulan este endpoint. Llame a REST directamente.