Article last updated on the 15th of December, 2022.
In this article, we will cover how to configure HTTP endpoints to be used in WorkPoint Automate processes.
HTTP endpoints allow you to integrate various web applications into your processes. An endpoint provides a simple way to define the base URL and authentication credentials to use when making HTTP requests for information from the endpoint/application.
An example of use for HTTP endpoints could be integrating a web app which provides address information into your WorkPoint process. In Denmark, "Dataforsyningen" provides such a service. Their API is located at https://api.dataforsyningen.dk/adresser and can provide address information when provided with a set of search queries. Required and/or optional search queries which can be passed to the endpoint can typically be found in the API documentation of the endpoint you are trying to access.
License requirement information is coming soon.
Note that configuration of HTTP endpoints require that you have access to an API from which you can retrieve information.
3.1. Accessing the Http Endpoint Library
HTTP Endpoints are configured in the WorkPoint 365 Administration:
- In the left side panel of the WorkPoint 365 Administration, click "Http Endpoint Library".
This opens the Http Endpoint Library page:
3.2. Adding a new Http Endpoint
In the following steps, we will configure a new Http Endpoint to be used in our WorkPoint Processes.
- To add a new Http endpoint, click the "Add" button.
- A title for the Http endpoint is required.
- For "Parameters" you can add parameters which can be passed to the endpoint API. Based on the parameters, the API will return output data. Note that some APIs require specific parameters be passed to them. Required parameters can typically be found in the documentation of the API.
- Check or uncheck the "Active" checkbox to enable or disable the Http endpoint. Only enabled Http endpoints can be used in processes.
- In the "URL" field, paste the URL to the Http endpoint you want to retrieve information from.
- In the Http(s) endpoint action field, you can select which type of Http action you wish to perform. Available options are:
- Delete: Used to delete a a resource
- Get: Used to read or retrieve a representation of a resource
- Post: Used to create a new resource inside a parent resource
- Put: Used to update an existing resource
- HTTP headers let the client and the server pass additional information with an HTTP request or response. Headers consist of Key and Value pairs. White space before the Value is ignored. Visit this article for more information about HTTP headers.
- In the "Query" section, you can add queries to be passed through the Http request to the API. Note that APIs may require specific queries be passed when calling them. Check your API's documentation for any required queries.
- In the "Body" field, you can type in a request for the API you are calling. This option is only available if you have selected either "Post" or "Put" as your Http(s) endpoint action.
- In the "Media type" field, you can select which type of data you are expecting to get back from the API. Examples could be "application.json" for json data or "text/xml" for xml data.
- If the API you are calling requires authentication before it can be used, you can select your configured credentials in the "Credentials" field. Authorizations/credentials are configured in the Http Endpoint Library.
- In the "Test" field you can test your query against the API using the parameters you have provided in step 2. If your configuration is valid, you should see a response from the API giving you some data, which is then displayed in the window above the test button.
- In the "Schema" field you can input the organization or structure for the data you access with the API. The schema defines the structure of data received by the endpoint, and can be generated automatically from a test result, if you have previously run a test which resulted in a successful response from the API. Note that you should always run another test after automatically generating the schema to ensure that it was generated correctly.
- To save the Http endpoint configuration and add it to your Http Endpoint Library, click the "Add" button.
3.3. Example configuration
Visit this article for an example configuration of a Http endpoint in WorkPoint.
3.4. Using Http endpoint in a WorkPoint process
Visit this article for a guide on how to implement Http endpoints in WorkPoint processes.
3.5. Using WorkPoint processes with Http endpoints
Visit this article for a guide on how to use WorkPoint processes which uses Http endpoints.