Getting Started

API Documentation

Exigo offers several powerful and diverse ways to manage your data. Whether you prefer using SOAP-based web services, OData REST calls, SQL queries, or all of the above, Exigo offers you the flexibility to develop your application as you see fit.

API Features Comparison

	Web Service	OData	Custom OData	Replicated SQL
Availability
Express clients
Enterprise clients
Accessing Data
Web technologies used to pull data	SOAP	OData via REST	OData via REST SQL (Enterprise only)	SQL
API result data types	XML	JSON, JSONP, XML	JSON, JSONP, XML SQL (Enterprise only)	SQL
Read existing records
Create, update and delete records				Custom OData tables only
Access to real-time data				Delayed ~ 10 sec. - 2 min.
Maximum records returned per call	Unlimited	50	500	Unlimited
Features
Server-side selective column querying
Server-side pagination
Server-side filtering, sorting and ordering
Server-side grouping, joins and aggregation			SQL - Yes OData - No
Extensibility
Allows developer to create and manage custom data tables	Custom reports available by request	Custom OData reports available by request		Custom SQL views available by request

Which API should I use?

Exigo provides several flexible methods to help you access your data because your needs change with every application and feature you develop. Here are some general guidelines we recommend when deciding which API to use:

Try using the web service when:

...you need to create, update or delete records.
...you need to pull real-time commissions.
...you need to place tree nodes.

Try using OData when:

...you want to read your data.
...you want your data returned in pre-built models.
...you want to choose which data columns to return for a faster result.
...you want to return real-time data.
...you want to return your data as JSON or JSONP.
...you want to paginate your results server-side.
...you need to pull historical commissions.

Try using replicated SQL when:

...you are an Enterprise client.
...you want to read your data.
...you want to join tables, group columns or aggregate data in your queries.
...you want to pull unlimited rows of data per call.
...your circumstance can afford to have the data be delayed a bit.

Try creating your own custom OData tables when:

...you need to store data that Exigo doesn't natively store.
...you want to build a feature that Exigo doesn't have pre-built.