Getting Started
Updated on : January 22, 2025, 6:17 pm
Definitions
Bridge
A Bridge is a group of sources for a single client.
Source
A source is an exlusive access from your application that will create tasks and wait for the return of data.
Task
A Task is all the informations required in JSON format to execute a method and return the data to a source.
Namespace
A namespace regroup a list of availabble methods for a software API.
Method
A Method is a specific action created by FMSync for a software API.
Agent
The agent is an application installed on the client side. Running as a windows service, his job is to process all tasks and returns relevant informations to your sources.
Round Trip Example
- On a client website, a user buy a new T-Shirt.
- Using cURL, the website post a new task, asking for an invoice creation in Sage 50. (Namespace = sage50ca, Method = invoice)
- Getting the new task from the website source, the agent will connect to Sage 50 and creates the new invoice
- Agent return the invoice number to the website using the webhook previously configured with the source.
- The website process the returned data and save the invoice number into his database.