Overview
API Callouts is the ReadiNow Platform feature that enables calling out to external third-party web APIs.
Data payloads can be included in both the request and response. In this way, ReadiNow can:
- Push data to external systems
- Pull data from external systems
Usage
When should I use API callouts?
Situations where using API Callouts would be appropriate can include:
- Pushing data from a ReadiNow application into a third-party system
- Pulling data from a third-party system into a ReadiNow application
- Requesting that one or more operations be performed on a third-party system as part of a ReadiNow workflow
- Notifying a third-party system of something that has occurred in a ReadiNow application
What kinds of APIs can ReadiNow APIs communicate with?
To communicate with a third-party system, ReadiNow and the third-party system must be compatible in the following ways:
- Transport
ReadiNow supports HTTP and HTTPS web requests - Message Format
ReadiNow supports JSON, XML, and plain text message formats - Authentication
ReadiNow supports unauthenticated APIs, OAuth 2.0, HTTP Basic authentication, API key authentication, and custom authentication (any authentication scheme that utilises the HTTP “Authorization” header)
Providing that these requirements are met, ReadiNow can connect to most web APIs (including REST-style APIs).
Connectivity
Finally, third-party APIs must be accessible over the public internet; if it is not physically possible for the ReadiNow servers to reach the third-party system (for example if it is an on-premises system), then it is not possible for API Callouts to be used.