Skip to content
Mike Russell edited this page May 3, 2016 · 15 revisions

#SugarCRM REST PHP Client

##Architecture There are four main components to the PHP REST Client

  • Client
  • The main object used to make calls to the API. It authenticates and manages authentication to the API throughout the usage of the Object lifespan.
  • Endpoint
  • A specific Endpoint of the API. Manages the Endpont URL, Data, Request and Response.
  • Requests
  • An object for manipulating Curl, without having to dig into Curl intself.
  • Response
  • An object for manipulating the Curl Response

These four areas are designated by the folder structure in the src/ directory of the repository. The interfaces folder in each of the subsequent directories, outline the basic usage that should be implemented for the architecture to succeed, but implementation can vary by how much logic is handled internally versus externally. Documentation from this point forward, will look specifically at the SugarAPI Client implementation.

##Basic Usage