ArchitectureOverview

Client

A Client Object does the following:

• Manages the Endpoint Objects and maps them to direct function calls
• Manages the Authentication to the API
  • Provides Login, Refresh, and Logout functions
  • Provides Token management for staying connected to the API
• Manages the URL to the API

Read detailed descriptions of all included functions and included uses in the Client page.

Endpoint

An Endpoint Object does the following:

• Manages the Endpoint URL relative to the Client's API URL
• Manages the Input data needed for a specific API Endpoint
• Manages the Request and Response Objects used to communicate with the API Endpoint

Read detailed descriptions of all included functions and included uses in the Endpoint page.

Request

A Request Object, is a wrapper for the PHP Curl functions. It provides an Object Oriented way of manipulating the Curl Resource

Read detailed descriptions of all included functions and included uses in the Request page.

Response

A Response Object, utilizes the Curl Resource of a Request Object and parses the Curl Response into a useful object.

Read detailed descriptions of all included functions and included uses in the Response page.