Getting Started

The acronym "API" stands for "Application Programming Interface". An API is just a defined way for a program to accomplish a task, usually retrieving or modifying data. In Coffee Bean case, we provide an API method for some of the features you see in our Social CRM application. Programmers use the Coffee Bean API to make applications, websites, widgets, and other projects that interact with Coffee Bean Social CRM. Programs talk to the Coffee Bean API over HTTP, the same protocol that your browser uses to visit and interact with web pages.

The API is RESTful and HTTP-based

Methods to retrieve data from the Coffee Bean API require a GET request. Methods that submit, change, or destroy data require a POST. A DELETE request is also accepted for methods that destroy data. API Methods that require a particular HTTP method will return an error if you do not make your request with the correct one. HTTP Response Codes are meaningful.

The Coffee Bean API attempts to conform to the design principles of Representational State Transfer (REST). Simply change the format extension of a request to get results in the format of your choice. The documentation notes which formats are available for each method. The API presently supports the following data formats: XML and JSON.

Date format

The API use the ISO 8601 Data elements and interchange formats. Please refer to [ISO_8601 on Wikipedia] for more details