Ottieni 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

Ottieni 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 Autenticazione: API key obbligatoria (Authorization: Bearer <API Key>). Solo autore dell’app; gli altri ricevono 404. Rilettura da parte dell’autore del manifest completo dell’ultima release (incluso il blocco runtime): la fonte dei dati per “modifica e ripubblica”. Con zero release restituisce 404. Gli autocontrolli del draft passano sempre dagli endpoint del workspace; non mescolare le due cose. runtime è un artefatto backend e non compare mai in payload pubblici come card o viste dettaglio, quindi questo endpoint è solo author. auth.secret è solo un alias in runtime.env; il plaintext delle credenziali vive nello secret store e non viene mai leakato in read-back. status e scope sono iniettati dallo stato ops corrente, non dai valori originali del manifest. I manifest non portano più identity.version; prendi i numeri di versione dalla lista versioni.

Richiesta

Parametri di percorso

string

obbligatorio

Riferimento app.

Esempio di richiesta

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

Risposta

200 successo

{
  "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 è l’oggetto manifest stesso (sopra solo la porzione iniziale).

Errori

HTTP	`code`	`category`	Descrizione
401	`unauthorized`	`forbidden`	API key mancante o non valida.
404	`release-not-found`	`not_found`	Quella versione non esiste, oppure l’app non ha ancora release.

Le risposte di errore usano {"error": {code, category, message, retryable}}. Vedi Errori.

Librerie client

Gli SDK Python e JavaScript non wrappano ancora questo endpoint. Chiama REST direttamente.

PER INIZIARE

GUIDA RAPIDA

RIFERIMENTO

DATA HUB API

Ottieni manifest

Richiesta

Parametri di percorso

Esempio di richiesta

Risposta

200 successo

Errori

Librerie client

​Richiesta

​Parametri di percorso

​Esempio di richiesta

​Risposta

​200 successo

​Errori

​Librerie client

Richiesta

Parametri di percorso

Esempio di richiesta

Risposta

200 successo

Errori

Librerie client