Manifest abrufen

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

Manifest abrufen

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 Authentifizierung: API-Schlüssel erforderlich (Authorization: Bearer <API Key>). Nur App-Autor; andere erhalten 404. Rücklesen des vollständigen Manifests des neuesten Release durch den Autor (einschließlich des runtime-Blocks) – die Datenquelle für „bearbeiten und erneut veröffentlichen“. Ohne Releases wird 404 zurückgegeben. Draft-Selbstprüfungen laufen immer über die Workspace-Endpoints; vermischen Sie beides nicht. runtime ist ein Backend-Artefakt und erscheint nie in öffentlichen Payloads wie Karten oder Detail-Views, daher ist dieser Endpoint nur für Autoren. auth.secret ist nur ein Alias in runtime.env; Credential-Klartext liegt im Secret-Store und leakt nie beim Read-back. status und scope werden aus dem aktuellen Ops-State injiziert, nicht aus den Original-Manifestwerten. Manifeste tragen kein identity.version mehr; Versionsnummern kommen aus der Versionsliste.

Anfrage

Pfadparameter

string

erforderlich

App-Referenz.

Beispielanfrage

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

Antwort

200 Erfolg

{
  "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 ist das Manifest-Objekt selbst (oben nur der führende Teil).

Fehler

HTTP	`code`	`category`	Beschreibung
401	`unauthorized`	`forbidden`	Fehlender oder ungültiger API-Schlüssel.
404	`release-not-found`	`not_found`	Diese Version existiert nicht, oder die App hat noch keine Releases.

Fehlerantworten nutzen {"error": {code, category, message, retryable}}. Siehe Fehler.

Client-Bibliotheken

Die Python- und JavaScript-SDKs wrappen diesen Endpoint noch nicht. REST direkt aufrufen.

ERSTE SCHRITTE

SCHNELLSTART

REFERENZ

DATA HUB API

Manifest abrufen

Anfrage

Pfadparameter

Beispielanfrage

Antwort

200 Erfolg

Fehler

Client-Bibliotheken

​Anfrage

​Pfadparameter

​Beispielanfrage

​Antwort

​200 Erfolg

​Fehler

​Client-Bibliotheken

Anfrage

Pfadparameter

Beispielanfrage

Antwort

200 Erfolg

Fehler

Client-Bibliotheken