API or Application Programming Interface is a set of functions and procedures that allow access to the features or data of an operating system, application, or other services, thus making it possible for applications to interact with each other and share data.
In ALX we use API calls to copy data from one target group to another. We also use them to send and receive data from many third party applications.
In order to ALX to send data to a third party system it must have the required endpoints and authentication model to allow the autologyx system to consume them. This will allow data to be passed between the systems.
An API request works like this:
- You configure your API request in your application/client;
- Based on the configuration, a call/request is sent to the third-party service via HTTPS;
- If the request is valid, the third-party service will respond with a structured object, most likely a JSON object containing your request’s data (again, the response body will likely depend on the type of request, i.e. the response from a GET Request will be different from that of a POST Request).
Before starting to make use of autologyx’s APIs, you need to create an API key which will be used for authentication. It is worth noting that different services will have different authentication methods, these can be (but not limited to):
- Basic Authentication;
- Bearer Token;
- API Key;
- OAuth 1.0;
- OAuth 2.0.
Depending on the authentication methods, you must configure your API Call accordingly.
Comments
0 comments
Please sign in to leave a comment.