Rest API endpoint config
An API endpoint is a specific URL where an API receives requests and sends responses. Each endpoint includes the following elements:
-
Name. This is the string that you will later use as first parameter of the
restApiGet()andrestApiPostfunctions. -
Description. Optional information.
-
Base url. The specific location of the resource, often including versioning and path parameters for specific items, e.g., https://api.openai.com/v1/chat/completions
-
Headers. Metadata for the request, such as Content-Type (e.g., application/json) or Authorization tokens to verify the user’s identity.
Note that the HTTP Method will be provided by the function calling the endpoint, i.e., restApiGet() to retrieve, and restApiPost() to create.
We support the HTTP PATCH method within our Rest API capabilities. This allows administrators developing IQL code to successfully execute API calls to external web services and third-party systems that strictly require the PATCH method for data updates.