Overview

This documentation serves as a guide on how to build applications using the fiyge backend. To enable FIYGE as a backend service .json must be appended to the end of each api path, ex: access_controls/users/login.json

FIYGE works off of basic actions /index, /view, /edit, /delete and /add

To call the API on a given controller, the structure is as follows.

https://{url}/{module}/{controller}/{action}.json

Example

https://v2.crm.immigrate.fiyge.com/crm/leads/index.json

url

The url is the base of the call, which points to which backend you are calling. This may vary for which orginization and version you are trying to access.

v2.crm.immigrate.fiyge.com  // v2
canstartco.fiyge.com        // v1

module

The module is a collection of controllers, bundled under one name. Permissions to a module may be assigned

CRM
Contracts
Legal
Documents
Projectivity
Developer
...

controller

The controller is the model we are trying to access which we can have fields, associations, views, permissions and other data objects.

Leads
People
Contracts
Matters
Documents
Invoices
...

Legend

• Auth
• Errors
• Index (List View)
• View (GET)
• Edit (POST)
• Delete
• Permissions
• JS Statements
• Form Inputs
• Form Displays
• Form Popups
• Form Grids
• Developer

Documentation to add for V2

• Permissions
• Form elements (in depth)
• JS statments
• Developer module
• Charts & Graphs
• Workflow (V3)