PHP API connection to simPRO for Rahul B

We will provide PHP interfaces that must be used to implement the functionality required for each trade system, these interfaces will provide the minimum required functionality which our existing system will call in order to trigger and request each update or set up authentication as required. Additional PHP files have been provided including specific structures to be used for interacting with files, job information and other communication. Interfaces Overview ================ ITradeSystem ---------------------- Handles the heavy lifting of communicating between our existing system and the Trade System, the methods outlined within this interface will be called by our existing system for all job/invoice related communication. This also provides the methods required to authenticate the user, test user credentials and revoke access. Our existing system will call these methods to control access to user accounts. IDocuments ------------------- Defines methods that our existing system will use when dealing with the files returned by the Trade Systems. Supplied Code Overview =================== TradeSystemBase ----------------------------- Implements a couple of common functions that will be shared across all Trade Systems such as getUserData() and setUserData() as well as common class level fields. Methods getUserData() Reads encrypted user data from the database and decrypts it. Data will be returned in same format as supplied via setUserData(). setUserData() Saves supplied data including access tokens / credentials to the database in an encrypted format. DocumentsBase -------------------------- Implements a couple of common functions that will be shared across all Trade Systems and Document types. DocumentsInvoice ------------------------------ Implements the required fields required for an invoice document and the required functions to interact with that data. Our existing system will expect the functions contained within. DocumentsQuote ---------------------------- Implements the required fields required for a quote or estimate document and the required functions to interact with that data. Our existing system will expect the functions contained within. JobStatus ---------------- This class provides common fields and functions that should be set when retrieving job information, all of these fields should be attempted to be set. CustomerNotes ------------------------- This class is designed to allow the simple translation of notes/communication between our existing system and the Trade Systems along with the Trade System back to our existing system. Sample Integration Code Overview ============================ TradeSystemExample ----------------------------------- Provides a basic overview showing how each of the components interact and pseudo code of talking to a fake 3rd party API. Additional Work ============= We want to use this same PHP interface/base for more than 10 different trade platforms, if you are successful with this project and deliver the project to meet our requirements you will be offered to complete the work for the other trade platforms.