To help orient you with the API Framework, the following definitions will be used throughout:

App Authorizations: Contains credentials to authorize an API connection, connection settings, and accessible API Resources

  • For example, you could create an authorization to only allow GETs, and another authorization that allows GETs and POSTs, for segmented calls to the same data store with user permissions based off the Authorization credentials.

API Resources: The data that is accessible via HTTP Methods.  API Resources have three types associated to them:

  • Standard
    • Allows GETs, POSTs, PUTs, and DELETEs on a single database table
    • Searchstrings are allowed
  • Complex
    • Only GETs are available for this type
    • Allows a custom query to return data from multiple database tables
    • (Optional) Allows you to manipulate data after an API call
      • For example, if you wanted to only retrieve orders that have not been retrieved previously, you could setup a Complex API Resource to GET the orders and mark the orders as retrieved, avoiding duplicate results on the following GET requests.
    • Searchstrings are allowed on the specified table
  • Special
    • Calls a function when the resource is called.
    • Searchstrings are not allowed with this Resource type

API Resource – Tags: Group resources together when dynamically generating exposed API endpoints per authorization via API Documentation.

API Resource – HTTP Path: The unique address of an endpoint for an API Call.

Was this article helpful

Related Articles

Subscribe to receive email updates of what's new in the CIMcloud Help Center.