マニフェスト取得
curl --request GET \
--url https://api.example.com/v1/data-apps/{app_id}/manifestimport requests
url = "https://api.example.com/v1/data-apps/{app_id}/manifest"
response = requests.get(url)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/data-apps/{app_id}/manifest")
.asString();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_bodyPublishing
マニフェスト取得
最新 Release の完全マニフェスト(runtime 含む)作者読み戻し。編集再公開用。
GET
/
v1
/
data-apps
/
{app_id}
/
manifest
マニフェスト取得
curl --request GET \
--url https://api.example.com/v1/data-apps/{app_id}/manifestimport requests
url = "https://api.example.com/v1/data-apps/{app_id}/manifest"
response = requests.get(url)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/data-apps/{app_id}/manifest")
.asString();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_bodyGET https://api-datahub.octoparse.com/v1/data-apps/{app_id}/manifest
認証:APIキー必須(Authorization: Bearer <API Key>)。App 作者のみ。他者は 404。
最新 Release の完全マニフェスト(runtime ブロック含む)の作者向け読み戻し — 「編集して再公開」のデータ源。
runtime はバックエンド成果物でカードや詳細などの公開ペイロードには出ないため、本エンドポイントは作者のみ。auth.secret は runtime.env への別名に過ぎず、資格情報の平文はここにもどこにも出ない。
リクエスト
パスパラメータ
string
必須
App reference.
リクエスト例
curl \
-H "Authorization: Bearer $OCTOPARSE_API_KEY" \
"https://api-datahub.octoparse.com/v1/data-apps/carol/reviews-query/manifest"
レスポンス
200 成功
{
"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 自体がマニフェストオブジェクト(上は冒頭のみ)。
エラー
| HTTP | code | category | Description |
|---|---|---|---|
| 401 | unauthorized | forbidden | API キー欠落または無効。 |
| 404 | release-not-found | not_found | そのバージョンが存在しない、または App にまだ Release がない。 |
{"error": {code, category, message, retryable}} です。エラー を参照。