Kezdőlap | Közösség | GYIK | Ügyek | Twitter | Dokumentáció szerkesztése
en hu

API dokumentáció

HTTP metódusok: GET, POST, PATCH

API eszközök: Bejelentkezés, Adat letöltés, Adat feltöltés, Beállítás módosítás

API kezelők:

Authentication handler (oauth):

/oatuh/token.php: Authentication

Authentication based interface (pds):

/projects/API_VERSION/projectname/pds.php: Data retrieval, Data push, Settings update

Non authenticated requests (web):

/projects/projectname/index.php

PDS API verzió:

Example: http://openbiomaps.org/projects/dead_animals/v2.1/pds.php The default version setting (if the version string missing from the URL) is 1.1., which compatible with the 2.0 and backward compatible with the 1.0.

OAUTH

An oauth2 implementation based on ttps://bshaffer.github.io/oauth2-server-php-docs/. OAUTH used in the web interface and in the PDS as well.

Változók

grant_type: password username: a rergistered email address password: password string scope: list of requested scope access in the autenticated session access_token: a valid access token

html authentication of clients is nesessary Kliensek: mobil, R, web

PDS

OBM API felület. Az R és mobil csatlakozási felülete. Az OAUTH-ot használja a bejelentkezések kezelésére.

Változók

scope: data methods: see below

value: some scope uses it

header: (put data) JSON list of table columns’ names

ignore_warning: (put data) ignore upload warnings

form_id: (put_data) set form id

data: (put data) JSON array of upload data

GET típusú feladatok

get_project_vars: query general project variables (available for non logined users as well).

További paraméterek:

project [text]: if not set default is the template project

Visszatérés:

  • project_url [url string]: web address of the project

  • project_description [text string]: short description of project

  • game [on/off]: game available for android mobile app

  • public_mapserv [url string]: url of publicly accessible map service

  • rserver_port [numeric]: numeric port number of R-Shiny server, accessible on project_url

get_project_list: get list and basis info of database projects available on the server.
További paraméterek:

only-project [text]: query project parameters only for the selected project, default is to query all accessible projects accessible [text]: all/accessible. If accessible parameter given and its value is “accessible” (default)

  • If user already logined, get list of those projects where user has account and where there are public query/upload interfaces.

  • If the user not logined, query public projects only.

Visszatérés:

  • project_table [string],

  • creation_date [date string],

  • Creator [string],

  • email [string],

  • stage [string] experimental/testing/stable,

  • doi [string],

  • running_date [date string],

  • licence [string],

  • rum [string],

  • collection_dates [date range string],

  • subjects [text],

get_form_list: query the list of available upload forms,

get_form_data: query the fields of the selected form

További paraméterek: value [numeric] numeric id of a form.

Visszatérés: lásd alább.

get_profile: get profile data of a selected user

get_data: get data rows from a selected data table (observation data)

get_specieslist: get species list from a project

get_history: get history of a selected data row

get_report: perform a predefined query and get the result

get_tables: get list of tables in a project

get_trainings: get list of available trainings/forms

Visszatérés: set of traning titles, ids and descriptions,…

get_training_questions: get list of questions for the selected training

További paraméterek: value [numeric] numeric id of a training.

Visszatérés: set of questions,answers and settings

training_results: status list of users’ trainings per forms. Status can be -1 (not sent), 0 (not validated yet), 1 (done, ok)

training_toplist: toplist of trainings. Mean, Max, Count values for each forms.

További paraméterek: value [text] summary without names (nonames).

get_mydata_rows: feltöltött adatok json formátumban

További paraméterek: value [numeric] limit of array length. If 0, no limit, default is no limit.

get_attachments: csatolt fájlok leszedése a szerverről egybe tarolva.

POST típusú feladatok

put_data: send/upload data using a selected form

PATCH típusú feladatok

set_rules: update specific settings

WEB API

Some kind of data access available on the web interface using stored unique URLs. These

Változók

query: (non-authenticated data retreive)

query_api: (non-authenticated data retreive, resulting JSON, XML, CSV output)

qtable: (non-authenicated table setting for data retreive)

report: (non-authenticated data retreive using stored query)

output: (non-authenticated data output setting)

LQ: (non-authenticated) display data from a stored query result

Get list of active (known) OpenBioMaps servers using query_api:

curl http://openbiomaps.org/projects/openbiomaps_network/index.php -G -d ‘query_api={“available”:”up”}&output=json&filename=’

Form Data (get_form_data results) explanations

Leírás: Opcionális oszlop leírás

Alap érték: Fix value for all observation. It can be controlled with the following options:

  • ‘_input’ it works as any other field with sticky flag.

  • ‘_list’ it works as any other list type field with sticky flag.

  • ‘_geometry’ it works as geometry type field

  • ‘_login_name’ this value overriden by the user’s name if logged in or returns as _input

  • ‘_email’ this value overriden by the user’s email address if logged in or returns as _input

  • ‘_autocomplete’ alias of input

  • ‘_boolean’ display as normal boolean list

  • ‘_attachment’ display as normal attachments field

  • ‘_datum’ display as normal date field

  • ‘_none’ not used

Column: The name of the column in the database

Short_name: Visible name of the column for the users

List: json array for menu items of a select menu. Can be {key:value} or [value,value] format

Control: Data checking commands: custom_check, minmax, spatial, nocheck, NULL

Count: (json array) If the control=’minmax’ this field contains the limit values, e.g 1:100

Type: column’s openbiomaps type:

  • autocomplete (json array)

  • boolean (two elements list)

  • crings (colour rings - text)

  • date (YYYY-MM-DD or other clear format)

  • datetime (YYYY-MM-DD HH:mm:ss)

  • file_id (file names as id by the server)

  • line (WKT geometry string)

  • list (json array)

  • numeric

  • point (WKT geometry string)

  • polygon (wkt geometry string)

  • text

  • time (HH:mm)

  • timetominutes (numeric value between 0 and 1440)

  • tinterval idő intervallum (HH:mm - HH:mm)

  • wkt (WKT sting)

Genlist: json array for menu items of an autocomplete menu. Can be {key:value} or [value,value] format

Obl: 1,2,3 (obligatory, non-obligatory, soft error) Soft error can be handled as non obligatory.

Api_params: json array of control values. Till API v2.0 only ‘sticky’ as an array element. Above API v2.0: {“sticky”:”off”,”hidden”:”off”,”readonly”:”off”,”list_elements_as_buttons”:”off”,”once”:”off”}.

Spatial_limit: WKT polygon string of spatial limit. It is used if the Control type is spatial.

List_definition: JSON array of complex list definition

Custom_function: null

permanent_sample_plots:

API < v.2.1

JSON array: [{“id”:”1110”,”name”:”Standard plots”,”geometry”:”POLYGON((16.5625…

API >= v.2.1

in “form_header”:{…,”permanent_sample_plots”:[{“id”:”1110”,”name”:”Standard plots”,”geometry”:”POLYGON((16.5625…

Training explanations and examples

Példák:

curl -F ‘scope=get_trainings’ -F ‘access_token=9d45…’ -F ‘project=dinpi’ http://localhost/biomaps/pds.php

Result of a successful call:

{“status”:”success”,”data”:[{“id”:”1”,”form_id”:”95”,”html”:”<div>…”,,”task_description”:”<div>…”,”enabled”:”t”,”title”:”Gyakorlás I.”,”qorder”:”1”,”project_table”:”dinpi”},{

curl -F ‘scope=get_training_questions’ -F ‘access_token=9d45…’ -F ‘project=dinpi’ http://localhost/biomaps/pds.php

Result of a successful call:

{“status”:”success”,”data”:[{“qid”:”1”,”training_id”:”1”,”caption”:”…?”,”answers”:”[{“Answer”: “…”,”isRight”: “false” }, ]”,”qtype”:”multiselect”}]}

qtype can be multiselect or singleselect

curl -F ‘scope=training_results’ -F ‘access_token=9bb4…’ -F ‘project=dinpi’ http://localhost/biomaps/pds.php

Result of a successful call:

{“status”:”success”,”data”:”{“95”:1,”96”:0,”97”:-1,”98”:-1}”}

Meaning of values: form-95 done, form-96 done, but not validated yet, form-97,98 not completed yet

curl -F ‘scope=training_toplist’ -F ‘value=nonames’ -F ‘access_token=5ac3…’ -F ‘project=dinpi’ http://localhost/biomaps/pds.php

Result of a successful call:

{“status”:”success”,”data”:{“95”:{“mean”:”0.50000000000000000000”,”count”:”2”,”max”:”0.7”},”96”:{“mean”:”0.70000000000000000000”,”count”:”1”,”max”:”0.7”},”97”:{“mean”:”0.70000000000000000000”,”count”:”1”,”max”:”0.7”},”98”:{“mean”:null,”count”:”1”,”max”:null}}}

curl -F ‘scope=training_toplist’ -F ‘access_token=5ac3…’ -F ‘project=dinpi’ http://localhost/biomaps/pds.php

{"status":"success","data":{
 "95":{"Bán Miki":{"mean":"0.30000000000000000000","count":"1","max":"0.3"},
       "Dr. Bán Miklós":{"mean":"0.70000000000000000000","count":"1","max":"0.7"}
      },
 "96":{"Dr. Bán Miklós":{"mean":"0.70000000000000000000","count":"1","max":"0.7"}},
 "97":{"Dr. Bán Miklós":{"mean":"0.70000000000000000000","count":"1","max":"0.7"}},
 "98":{"Dr. Bán Miklós":{"mean":null,"count":"1","max":null}}}
}

Példák

Authentication:

curl \
-u mobile:mobile http://openbiomaps.org/oauth/token.php \
-d "grant_type=password&username=foo@foobar.hu&password=abc123&scope=get_form_data+get_form_list+put_data"

Data retrieval (form list):

curl \
-v http://openbiomaps.org/projects/checkitout/pds.php \
-d "access_token=d4fba6585303bba8da3e6afc1eb9d2399499ef3e&scope=get_form_list"
Result of a successful get_form_list call:

{“status”:”success”,”data”:[{“form_id”:”93”,”form_name”:”lepke űrlap”},{ …

Data retrieval (form fields):

curl \
-v http://openbiomaps.org/projects/checkitout/pds.php \
-d "access_token=d4fba6585303bba8da3e6afc1eb9d2399499ef3e&scope=get_form_data&value=93"

OR with central pds

curl \
-F 'scope=get_form_data' \
-F 'value=93' \
-F 'project=checkitout' \
http://openbiomaps.org/projects/checkitout/pds.php

OR with access token to retrieve data of a restricted form

curl \
-F 'access_token=...' \
-F 'scope=get_form_data' \
-F 'value=124' \
-F 'project=checkitout' \
http://openbiomaps.org/projects/checkitout/pds.php

Csatolmányok letöltése szűréssel:

curl \
-F 'access_token=...' \
-F 'scope=get_attachments' \
-F 'project=sablon' \
-F 'value=filter=gyujto!=Fakenuba Furamuki' \
http://localhost/biomaps/resources/pds.php -OJ

Csatolmányok letöltése limit-offset megadással (az első sortól 20 sor):

curl \
-F 'access_token=...' \
-F 'scope=get_attachments' \
-F 'project=sablon' \
-F 'value=limit=20:0' \
http://localhost/biomaps/resources/pds.php -OJ

Csatolmányok letöltése limit-offset megadással és több szűréssel:

curl \
-F 'access_token=...' \
-F 'scope=get_attachments' \
-F 'project=sablon' \
-F 'value=filter=gyujto=Fakenuba Furamuki&limit=1000:0&filter=tema=novenyek' \
http://localhost/biomaps/resources/pds.php -OJ

Result of a successful get_form_data call:

API < v.2.1

{"status":"success",
 "data":[
 {"description":null,
  "default_value":null,
  "column":"egyedszam",
  "short_name":"egyedszam",
  "list":"",
  "control":"minmax",
  "count":"{30,40}",
  "type":"numeric",
  "genlist":null,
  "obl":"3",
  "api_params":null},
 {"description":"faj neve",
  "default_value":null,
  "column":"faj",
  "short_name":"faj",
  "list":"",
  "control":"nocheck",
  "count":"{}",
  "type":"text",
  "genlist":null,
  "obl":"1",
  "api_params":null
  },
  {...}]
}

API >= v.2.1

{
 "status":"success",
 "data":[
 "form_header":{"login_name":"John Smith","login_email":"jsmith@openbiomaps.org"},
 "form_data":[
      {"description":"faj neve",
       "default_value":null,
       "column":"faj",
       "short_name":"faj",
       "list":"",
       "control":"nocheck",
       "count":"{}",
       "type":"text",
       "genlist":null,
       "obl":"1",
       "api_params":{"sticky":"off",
                     "numeric":"off",
                     "list_elements_as_buttons":"off"}
      },
      {...}]]
}
Adatfeltöltés:

curl \
-i \
-X POST \
-H “Content-Type:application/x-www-form-urlencoded” \
-H “Authorization:Bearer …” \
-d “scope=put_data” \
-d “form_id=128” \
-d “header=[“obm_geometry”,”obm_datum”,”time”,”datum”,”comment”,”longitude”,”latitude”,”observer”]” \
-d “data=[{“obm_geometr y”:”point(48.071187 19.293714)”,”obm_datum”:”2018-04-03 23:05”,”time”:”12”,”datum”:”2018-04-03”,”comment”:”asdad”,”longitude”:”0”,”latitude”:”0”,”observer”:”sdsaada”}]” \
-d “ignore_warning=1” \
http://openbiomaps.org/projects/checkitout/pds.php

Adat feltöltés több csatolmánnyal (fájlok):

curl \
-F “access_token=…” \
-F ‘scope=put_data’ \
-F ‘form_id=58’ \
-F ‘header=[“faj”,”obm_geometry”,”obm_files_id”]’ \
-F ‘batch=[\
{“data”:[{“faj”:”Sylvia curruca”,”obm_geometry”:”POINT(22.0 46.3)”}],”attached_files”:”file1,file2”},\
{“data”:[{“faj”:”Lanius Collurio”,”obm_geometry”:”POINT(21.5 47.1)”}],”attached_files”:”file3”}]’ \
-F ‘file1=@file1’ \
-F ‘file2=@file2’ \
-F ‘file3=@file3’ \
http://localhost/biomaps/projects/template/pds.php

Packed data upload. Data line in ZIP archive. This is the old mobile app’s export format. The ZIP file contains the following files:

geometry.wkt
PICT01.JPG
PICT02.JPG
note.txt

The ZIP file name is ‘Sun May 13 08:52:51 CEST 2018.zip’ which created from the observation date-time sting. The note.txt contains the observation comment which can be associated with one column of the form. In this example it is the ‘faj’. The other 3 columns shouldn’t be replaced or neglected. If there are some obligatory column in the form, those can be filled by the default_value parameter. In this example the ‘egyedszam’ column is an obligatory field which will be filled with ‘1’. Packed lines can be super packed. In this case ‘packed_line’ parameter should be changed to ‘multipacked_lines’ and the zip archive should contains zip files detailed above.

curl \
-F ‘scope=put_data’ \
-F ‘table=dinpi’ \
-F ‘form_id=58’ \
-F ‘header=[“obm_geometry”,”obm_files_id”,”faj”,”dt_to”]’ \
-F ‘default_values={“egyedszam”:”1”}’ \
-F ‘packed_line=@Sun May 13 08:52:51 CEST 2018.zip’ \
http://localhost/biomaps/pds.php

Data retrieval (non-authenticated report):

wget http://localhost/biomaps/projects/dinpi/?report=2@szamossag&output=csv

Refresh token (from R):

curl \
-F ‘grant_type=refresh_token’ \
-F ‘refresh_token=…’ \
-F ‘client_id=R’ \
http://openbiomaps.org/oauth/token.php

Returns:
{“access_token”:”…”,
“expires_in”:3600,
“token_type”:”Bearer”,
“scope”:”get_form_data …”,
“refresh_token”:”…”}

Project list (using central pds):

curl \
-F ‘scope=get_project_list’ \
http://localhost/biomaps/pds.php

Returns:
JSON array of those project which has public upload forms, or the user (if logined) member of it.

Általános API válaszok

A https://labs.omniti.com/labs/jsend ajánlást követve:

JSON:

{“status”:”X”,”data”:”“,”message”:”“}

X: success, error, fail