代码拉取完成，页面将自动刷新
This page documents Protobi's REST API which can be called from any web interface, including browsers, Node.js, R, Python etc. Examples here are shown using jQuery.
This page also documents the Protobi Node.js SDK which simplifies calling the REST API for a specific project.
npm install github:protobi/protobi-javascript-api
Authenticate either by secure cookie or API Key.
To login via API key, append ?apiKey=<YOUR_API_KEY> to the URL as a query parameter.
Your API key can be obtained at https://app.protobi.com/account
(or if you have Protobi Enterprise, use https://yourdomain.protobi.com/account ).
Keep the API confidential, it provides access to your projects as if you had logged in.
GET
https://app.protobi.com/v3/datasets/:datasetId/data/:key/:type
datasetId unique identifier for datasetkey data key, e.g. 'main'type, e.g. csv, sav, or raw to return the original file. $.ajax({
type: "GET",
url: "/api/v3/dataset/<DATASETID>/data/<FILEKEY>?apiKey=<APIKEY>",
success: function (csv, status, xhr) {
...
},
error: function (xhr, status, err) {
...
}
})
POST
https://app.protobi.com/v3/datasets/:datasetId/data/:key/:type
datasetId unique identifier for datasetkey data key, e.g. 'main'Send the data as form data under attribute file with subattributes filename and content-type.
To upload CSV data, use content-type: "text/csv".
To upload SAV data, use content-type: "'application/octet-stream'"
var boundary = '-----------------------------7da24f2e50046'//arbitrary
$.ajax({
type: "POST",
url: "/api/v3/dataset/<DATASETID>/data/<FILEKEY>?apiKey=<APIKEY>",
contentType: "multipart/form-data; boundary=" + boundary
data: boundary + '\r\n'
+ 'Content-Disposition: form-data; name="file";'
+ 'filename="' + filename + '"\r\n'
+ 'Content-type: text/csv\r\n\r\n'
+ csv + '\r\n'
+ boundary,
success: function (data, status, xhr) {
...
},
error: function (xhr, status, err) {
...
}
});
GET
https://app.protobi.com/v3/datasets/:datasetId/element
datasetId unique identifier for dataset $.ajax({
type: "GET",
dataType: "json",
url: "/api/v3/dataset/<DATASETID>/element",
success: function (csv, status, xhr) {
...
},
error: function (xhr, status, err) {
...
}
})
POST
https://app.protobi.com/v3/datasets/:datasetId/element
datasetId unique identifier for dataset $.ajax({
type: "POST",
url: "/api/v3/dataset/<DATASETID>/element",
dataType: "json",
contentType: 'application/json',
data: JSON.stringify(elements),
success: function (data, status, xhr) {
...
},
error: function (xhr, status, err) {
...
}
})
In Node.js require the library and initialize it for a specific host and API key
var ProtobiAPI = require('./js/protobi-javascript-api')
var PROTOBI_URL = "https://app.protobi.com"
var PROTOBI_API_KEY = "c1001580-56f4-400e-a210-212d03309e80"
var protobiAPI = new ProtobiAPI(PROTOBI_URL, PROTOBI_API_KEY)
/**
* Save array of Element objects to a project
* @param elements
* @param datasetId
* @param callback
*/
uploadElements: function ( elements, datasetId, callback) {...},
/**
* Retrieve project configuration as an array of elements
* @param datasetId
* @param elements
* @param callback
*/
getElements: function (datasetId, elements, callback) {...},
/**
* Upload csv string to project data entry as a data file,
* @method upload_csv
*/
uploadCsv: function (csv, datasetId, dataKey, filename, callback) {...},
/**
* Download csv string to project data entry as a data file,
* @method upload_csv
*/
downloadCsv: function (url, callback) {...},
uploadData: function (rows, datasetId, dataKey, filename, callback) { ... },
/**
* Download
* @param datasetId
* @param dataKey
* @param rows
* @param filename
* @param callback function(err, rows)
*/
getData: function (datasetId, dataKey, callback) {...},
var elements = [
{
key: "$root",
children: ["fruit","color"]
},
{
key: "fruit",
title: "Name of fruit",
type: "string"
},
{
key: "color",
title: "Color",
type: "string"
}
}
protobiAPI.uploadElements(elements, PROTOBI_PROJECT_ID, function (err) {
if (err) return callback(err);
console.log("ELEMENTS uploaded")
})
// example data
var data = [
{ fruit: "Apple", "color": "red",
fruit: "Banana", "color": "yellow",
fruit: "Cherry", "color": "red",
fruit: "Date", "color": "brown"
}
]
protobiAPI.uploadData(data, PROTOBI_PROJECT_ID, "main", null, function (err) {
if (err) return callback(err);
console.log("DATA uploaded")
})
All functions return a Promise if no callback method is specified. This allows functions to be used with async await.
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
马建仓 AI 助手
