Obtenir le manifest

curl --request GET \
  --url https://api.example.com/v1/data-apps/{app_id}/manifest

const options = {method: 'GET'};

fetch('https://api.example.com/v1/data-apps/{app_id}/manifest', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}/manifest",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/data-apps/{app_id}/manifest"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/data-apps/{app_id}/manifest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

GET

data-apps

{app_id}

manifest

Obtenir le manifest

curl --request GET \
  --url https://api.example.com/v1/data-apps/{app_id}/manifest

const options = {method: 'GET'};

fetch('https://api.example.com/v1/data-apps/{app_id}/manifest', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}/manifest",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/data-apps/{app_id}/manifest"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/data-apps/{app_id}/manifest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

GET https://api-datahub.octoparse.com/v1/data-apps/{app_id}/manifest Authentification : clé API requise (Authorization: Bearer <API Key>). Auteur de l’app uniquement ; les autres reçoivent 404. Relecture auteur du manifest complet de la dernière Release (bloc runtime inclus) — source de données pour « éditer puis republier ». Zéro release → 404. Les auto-contrôles de brouillon passent toujours par les endpoints workspace ; ne mélangez pas les deux. runtime est un artefact backend et n’apparaît jamais dans les charges publiques comme cartes ou détail market. Seul l’éditeur le voit en lecture workspace/manifest et au téléchargement du contrat.

Requête

Paramètres de chemin

string

requis

Référence d’app.

Exemple de requête

curl \
  -H "Authorization: Bearer $OCTOPARSE_API_KEY" \
  "https://api-datahub.octoparse.com/v1/data-apps/carol/reviews-query/manifest"

Réponse

200 succès

{
  "data": {
    "spec_version": "0.2",
    "identity": {
      "app_name": "probe-b",
      "name": "Runs list probe source",
      "summary": "Test app for runs list pagination and filters",
      "type": "data"
    },
    "discovery": {
      "keywords": [
        "runs-list-probe"
      ]
    },
    "input": {
      "schema": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string"
          }
        },
        "required": [
          "product"
        ]
      }
    },
    "output": {
      "id_field": "review_id",
      "schema": {
        "type": "object",
        "properties": {
          "review_id": {
            "type": "string"
          }
        }
      }
    },
    "execution": {
      "mode": "sync",
      "timeout_seconds": 60
    },
    "pricing": {
      "events": [
        {
          "event": "record",
          "label": "Fetch one record",
          "unit_price": 0.001
        }
      ]
    },
    "runtime": {
      "kind": "api",
      "env": {
        "base": "PARTNER_API_BASE",
        "api_key": "PARTNER_API_KEY"
      },
      "api": {
        "auth": {
          "type": "api_key",
          "in": "header",
          "name": "X-API-Key",
          "secret": "api_key"
        },
        "response_code": {
          "path": "code",
          "ok_codes": [
            20000
          ],
          "message_path": "message"
        },
        "fetch": {
          "request": {
            "method": "GET",
            "url": "{env.base}/api/envelope/reviews",
            "query": {
              "product": "{input.product}"
            }
          },
          "response": {
            "records_path": "data.records",
            "field_map": {
              "review_id": "id"
            }
          }
        }
      }
    },
    "status": "published",
    "scope": "private",
    "namespace": "carol",
    "source_locale": "zh-CN"
  }
}

data est l’objet manifest lui-même (seule la portion initiale est montrée ci-dessus).

Erreurs

HTTP	`code`	`category`	Description
401	`unauthorized`	`forbidden`	Clé API manquante ou invalide.
404	`release-not-found`	`not_found`	Cette version n’existe pas, ou l’app n’a pas encore de releases.

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.

BIEN DÉMARRER

DÉMARRAGE RAPIDE

RÉFÉRENCE

DATA HUB API

Obtenir le manifest

Requête

Paramètres de chemin

Exemple de requête

Réponse

200 succès

Erreurs

Bibliothèques clientes

​Requête

​Paramètres de chemin

​Exemple de requête

​Réponse

​200 succès

​Erreurs

​Bibliothèques clientes

Requête

Paramètres de chemin

Exemple de requête

Réponse

200 succès

Erreurs

Bibliothèques clientes