RESTful APIs

Organizations, other than those using with the Starter or Pilot Editions, that wish to access their information can do so via RESTful Application Programming Interfaces (RESTful APIs) after securing an account and attaining their unique identifier (Tenant ID).  If you do not have an account please bother us so we can get started immediately.  The list of product APIs resides here.

This information, herein, assumes familiarity with JavaScript Object Notation (JSON) and how to make web service calls.  In theory you can use any development environment or tool capable of making web service calls and parsing JSON objects.  While we do not advertise training and coaching services on the use of JSON we do offer training on the use of our APIs for organizations that want to exploit them.

We are always looking to add value to our Products so do not hesitate to bother us to help integrate your information into your product or a Commercial-Off-The-Shelf (COTS) product.  As well, we are always looking for add to our product so forward your suggestions and if we add it to a future version you will get some cool swag.

Using Our APIs

The first parameter to any call is the TenantID field, which identifies your organization and controls the data you can retrieve.  Besides the data you are seeking to retrieve, all calls will return the following information.

CodeResultDescription
200OKResolved the get request successfully and the body contains the response.
Everything is working
201OKNew resource has been created
204OKThe resource was successfully deleted
400Bad RequestEither required headers are missing or the body of the JSON is malformed.
The request was invalid because of a missing or invalid parameter from client-side code
401UnauthorizedThe request requires an user authentication. Likely the client-side code is using the incorrect Tenant ID
403ForbiddenThe caller is not authorized to perform this operation.
The server understood the request, but is refusing it or the access is not allowed. Examples: Tenant ID is wrong or not provided.
404Not FoundSubscription not found with the given ID
The requested resource does not exist
422Unprocessable Entity Should be used if the server cannot process the enitity, e.g. if an image cannot be formatted or mandatory fields are missing in the payload
500Internal Server ErrorUnexpected problem on server side (Our Microsoft Azure instance)
503Service UnavailableService is down temporarily, retry later.
Unexpected problem on server side (Our Microsoft Azure instance)

To access demo data, simply click on any of the links second table above.  You will be able to utilize all of our APIs but with read only access.

Tip: You should store the TenantID as a parameter to the application, rather than hard-code it into the API calls.

Return Codes

We utilize the same return codes that one would expect with HTTP.  In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed because of the provided information, and codes in the 5xx range indicate very rare error due to issues within our Microsoft Azure instance.

ItemTypeDescription
Success BooleanValue indicating whether the call worked
StatusCodeInteger HTTP response code
CountIntegerNumber of data elements
MessageStringShort description of object
DataObject or CollectionThe actual data object or collection from the API call

Follow Us!         

info@ClearlyAgile.com     support@ClearlyAgile.com     careers@ClearlyAgile.com

(833) AGILE 4 U     (833) 244-5348

Copyright © 2018, Clearly Agile, Inc. All Rights Reserved.