REST API Concepts

Cloud database API presented here extends all functionality implemented in web-based tasks and processes, allowing you to connect and manage your data externally from a client-side script or any third party plugin. The REST API architecture brings together HTTP, URI, JSON, and XML standards by prescribing a mechanism for communicating requests and exchanging data between a server and a client. When issuing a call to query or modify a specific resource, client will issue a standard HTTP GET or POST request to a specific URL containing a path to the resource in question. For example a GET request addressed at https://api.recon.work/company/Test_Co/user URL will communicate to the server your intent to receive a list of all users in "Test_Co". While issuing a POST request to the same URL will indicate that you want to add new users to the "Test_Co" company.

Request Types

When issuing HTTP requests to the server resources, each request is evaluated individually, instructing the server to perform an action according to the following table:

HTTP Method	Corresponding Action
GET	Request the content of the resource specified
POST	Append new data to the resource specified
PUT	Replace the content of the resource specified
DELETE	Completely remove the resource specified

List of API Resources

The URL of your request will have to contain sufficient information to uniquely identify the resource that is being modified or queried. The full resource URL path can be build by combining https://api.recon.work/company/Test_Co with the suffixes listed in the following table:

Top Instruction	Specific Action	URL Suffix
Retrieve Data	Get IP Security	/security
Retrieve Data	Get System Log	/log
Retrieve Data	Get All Collection Names	/collection
Retrieve Data	Get Documents from a Collection	/collection/Bike%20Inventory
Retrieve Data	Get Collection Security	/collection/Bike%20Inventory/security
Retrieve Data	Get Aggregated Results	/collection/Bike%20Inventory/aggregate
Retrieve Data	Get Document by ID	/collection/Bike%20Inventory/document/58fd1d
Retrieve Data	Get All User Accounts	/user
Retrieve Data	Get User Details	/user/john.doe%40gmail.com
Retrieve Data	Get User Security	/user/john.doe%40gmail.com/security
Retrieve Data	Get All Process Names	/process
Retrieve Data	Get Process Details	/process/Form%20Demo
Retrieve Data	Get Specific Process Step	/process/Form%20Demo/step/12
Retrieve Data	Get Process Security	/process/Form%20Demo/security
Add Data	Add IP Security Rules	/security
Add Data	Create New Collection	/collection
Add Data	Add New Document to Collection	/collection/Bike%20Inventory
Add Data	Add New User	/user
Add Data	Add New Process	/process
Replace Data	Replace IP Security Rules	/security
Replace Data	Replace Collection Security	/collection/Bike%20Inventory/security
Replace Data	Replace Specific Document	/collection/Bike%20Inventory/document/58fd1d
Replace Data	Replace User Details	/user/john.doe%40gmail.com
Replace Data	Replace User Security	/user/john.doe%40gmail.com/security
Replace Data	Replace Process Definition	/process/Form%20Demo
Replace Data	Replace Process Security	/process/Form%20Demo/security
Delete Data	Remove Collection	/collection/Bike%20Inventory
Delete Data	Remove Specific Document	/collection/Bike%20Inventory/document/58fd1d
Delete Data	Remove User	/user/john.doe%40gmail.com
Delete Data	Remove Process	/process/Form%20Demo

Messaging Standard

All communications with the server are expected to utilize JSON format. Any URL query parameters that originally were in JSON format need to be stringified and then URL encoded before transmission. Likewise, request body content needs to contain stringified JSON text.

Server responses will always contain JSON text that parses to a single document containing the following properties:

• res - Number, 1 for success, 0 for failure.
• data - JSON document containing the results of the query.
• msg - Populated with explanatory message only when error occurred.

API Security

Access to the programming interface is granted to any individual having the "API User" security role in their profile. Additionally, an API security token will have to be generated before initiating any programming calls described above. A new key can be easily obtained by going to the following path in the user menu: System Functions -> API User -> Generate API Key. In order to properly use the key, please include it in all your HTTP requests by appending it to the authorization header as follows: Authorization: Basic NTkwOtE...

Back to Main