In RealEquity, we’re operating with three distinct RESTful API interfaces:
- Online API
- Sync API
- BI API
The three API interfaces use the same authentication mechanism, so if you’ve got access to one, you’ve got access to all of them. They also provide exactly the same end points. The key difference between them is their relative performance and price per transaction.
Online API:
This interface has very high capacity and very low response times. Requests through this interface are granted a higher priority than requests through the Sync and BI APIs. For the best user experience, it’s recommended to use this interface for interactions where the response is to be presented to a user in real-time.
Base URL:
api.prod.realequity.dk/api/
Cost per transaction:
Depends on your Partner status.
Sync API
This interface has relatively high capacity and relatively low response times. Requests through this interface are granted a higher priority than requests through the BI API, but lower than requests through the Online API. It’s recommended to use this interface for e.g. system-to-system synchronizations where a latency of seconds is acceptable.
Base URL:
sync.prod.realequity.dk/api/
Cost per transaction:
50% of an Online API transaction.
BI API
Requests through this interface haven’t got priority and a served once capacity is available (i.e. isn’t prioritized by the alternative interfaces). It’s recommended to use this interface for e.g. system migrations and BI solutions where a latency of minutes is acceptable.
Base URL:
bi.prod.realequity.dk/api/
Cost per transaction:
20% of an Online API transaction.