Data

Learn how to post data to the project.

Get a global data entry

GET https://api.echo3D.com/get?key=<API_KEY>&data=<DATA>

This query allows you to get global data entries.

Query Parameters

Name	Type	Description
key*	string	Your API key.
data*	string	A data key, e.g. scale.
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page.

200

<VALUE>

400

404

Post a global data entry

POST https://api.echo3D.com/post?key=<API_KEY>&data=<DATA>&value=<VALUE>

This query allows you to add a global data entry.

Query Parameters

Name	Type	Description
key*	string	The API key.
data*	string	A data key, e.g. scale.
value*	string	A data value, e.g. 2.
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page.

200

<VALUE>

400

Delete global data entry

POST https://api.echo3d.com/remove?key=<API_KEY>&data=<DATA>&email=<EMAIL>

This query allows you to remove a global data entry.

Request Body

Name	Type	Description
key*	string	Your API key
data*	string	A data key, e.g. scale.
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page

Get metadata of an entry

GET https://api.echo3D.com/get?key=<API_KEY>&entry=<ENTRY>&data=<DATA>

The query allows you to get metadata of a specific entry. You can either query for a specific data key or for all the data associated with the entry.

Query Parameters

Name	Type	Description
key*	string	Your API key.
entry*	string	A specific entry ID.
data*	string	A data key, e.g. scale.
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page.

200

{
    "<KEY_1>": "<VALUE_1>",
    "<KEY_2>": "<VALUE_2>",
    "<KEY_3>": "<VALUE_3>",
    ...
}

302

400

404

Post metadata to an entry

POST https://api.echo3D.com/post?key=<API_KEY>&entry=<ENTRY>&data=<DATA>&value=<VALUE>

This query allows you to add metadata to a specific entry.

Query Parameters

Name	Type	Description
key*	string	Your API key
entry*	string	A specific entry ID.
data*	string	A data key, e.g. scale.
value*	string	A data value, e.g. 2.
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page.

200

Additional data <DATA,VALUE> updated in entry <ENTRY>.

400

Delete metadata from an entry

POST https://api.echo3d.com/remove?key=<API_KEY>&entry=<ENTRY>&data=<DATA>&email=<EMAIL>

This query allows you to remove metadata to a specific entry.

Request Body

Name	Type	Description
key*	string	Your API key
entry*	string	A specific entry ID.
data*	string	A data key, e.g. scale.
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page

200: OK

Additional data key <data> removed in entry <entry>

400: Bad Request

Post metadata to a few entries with the same data name at the same time

POST https://api.echo3d.com/batchpost?key=<API_KEY>&entries=<ENTRY_IDs>&data=<DATA>&value<ENTRY_VALUES>

You can set a few entries with the same data name together, even if they have a different value

Request Body

Name	Type	Description
key*	string	Your API key
entries*	string	A list of entries to update, separated by a comma (',')
data*	string	A data key, e.g. scale.
value*	string	A list of data values, corresponding with the entry IDs, separated by a comma (','). e.g. 2,5,1. Your number of values must be the same as the number of entries you wish to update.
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page

Query the number of clicks received by custom buttons for WebAR

GET https://api.echo3D.com/query?key=<API_KEY>&webARButtonClick=true

Request Body

Name	Type	Description
key*	string	Your API key
webARButtonClick*	string	true, to get the number of clicks
email*	string	Your email address
userKey*	string	Your authentication key
secKey	string	Your Secret key. Only if enabled through the Security page.

200: OK

{
  "topLeftClickCounter": 0,
  "bottomRightClickCounter": 0,
  "centerClickCounter": 0,
  "rightClickCounter": 0,
  "topRightClickCounter": 0,
  "bottomClickCounter": 0,
  "bottomLeftClickCounter": 0,
  "leftClickCounter": 0,
  "topClickCounter": 0
}

400: Bad Request