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 MethodCorresponding Action
GETRequest the content of the resource specified
POSTAppend new data to the resource specified
PUTReplace the content of the resource specified
DELETECompletely 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 InstructionSpecific ActionURL Suffix
Retrieve DataGet IP Security/security
Retrieve DataGet System Log/log
Retrieve DataGet All Collection Names/collection
Retrieve DataGet Documents from a Collection/collection/Bike%20Inventory
Retrieve DataGet Collection Security/collection/Bike%20Inventory/security
Retrieve DataGet Aggregated Results/collection/Bike%20Inventory/aggregate
Retrieve DataGet Document by ID/collection/Bike%20Inventory/document/58fd1d
Retrieve DataGet All User Accounts/user
Retrieve DataGet User Details/user/john.doe%40gmail.com
Retrieve DataGet User Security/user/john.doe%40gmail.com/security
Retrieve DataGet All Process Names/process
Retrieve DataGet Process Details/process/Form%20Demo
Retrieve DataGet Specific Process Step/process/Form%20Demo/step/12
Retrieve DataGet Process Security/process/Form%20Demo/security
Add DataAdd IP Security Rules/security
Add DataCreate New Collection/collection
Add DataAdd New Document to Collection/collection/Bike%20Inventory
Add DataAdd New User/user
Add DataAdd New Process/process
Replace DataReplace IP Security Rules/security
Replace DataReplace Collection Security/collection/Bike%20Inventory/security
Replace DataReplace Specific Document/collection/Bike%20Inventory/document/58fd1d
Replace DataReplace User Details/user/john.doe%40gmail.com
Replace DataReplace User Security/user/john.doe%40gmail.com/security
Replace DataReplace Process Definition/process/Form%20Demo
Replace DataReplace Process Security/process/Form%20Demo/security
Delete DataRemove Collection/collection/Bike%20Inventory
Delete DataRemove Specific Document/collection/Bike%20Inventory/document/58fd1d
Delete DataRemove User/user/john.doe%40gmail.com
Delete DataRemove 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:

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