Architecture

Architecture Overview

This project follows a structured approach for interacting with the SugarCRM REST API, organized into three major components:

1. Auth Controller

• Responsibility: Manages API authentication and authorization. It ensures that each request is properly authenticated before reaching the API.
• Key Features:
  • Handles login, token refreshing, and session management.
  • Provides secure token storage and retrieval mechanisms.
  • Ensures that requests to the API are properly authorized with the correct credentials.
  • Necessary set of actions, mapped to the API Endpoints that trigger them by default, there is a required "Authenticate" action
  • Store and manage credentials and tokens
  • Setup of Requests to flow to the API

2. API Endpoints

• Responsibility: Acts as a registry for all available API endpoints, encapsulating logic specific to each route and its parameters.
• Key Features:
  • [Endpoint Provider] Provide a way to simplify the API to actions against the Client or actions against an Object (Models/Collections)..
  • [Endpoints] Provides clear abstractions for endpoint-specific logic, reducing the need to manually remember or define parameters with each request.
  • [Endpoints] Makes it intuitive to interact with the API by exposing methods that mirror the endpoints’ functions.
  • [Endpoints] Provide advanced logic to automate working withe API

3. Http Controller

• Responsibility: Manages the entire HTTP request/response lifecycle, ensuring proper communication with the API.
• Key Features:
  • Coordinates sending HTTP requests and receiving responses.
  • Handles error handling, retries, and response parsing in a centralized manner.
  • Provides utilities to manage headers, cookies, timeouts, and other HTTP-specific concerns.
  • Logic to automate request/response life cycle, and provide intuitive interface to API

Optionally, the endpoint can provide some extra features for more robust API Client functionality.

• Key Features:
  • Controller Data Object - a data object that controls data requirements or takes input to generate larger payloads needed by the API.
  • Event Stack - provide a programmatic way to alter Endpoint behavior without having to extend classes
  • Storage - a way for endpoints to cache/store data between processes and lifecycles

---

Flow of Interaction:

1. Auth Controller authenticates the user and retrieves a token.
2. The API Endpoints registry abstracts the various API routes, making it easier to interact with them programmatically.
3. The Http Controller sends the request, manages the response lifecycle, and ensures that any necessary data is handled efficiently.

This architecture makes it easier to maintain, test, and extend interactions with the API while abstracting away repetitive details, improving developer productivity.