SuperiorAPIs icon

SuperiorAPIs

Select and call APIs from SuperiorAPIs platform

SuperiorAPIs

AI-generated

Overview

This node integrates with the SuperiorAPIs platform, allowing users to select and call various APIs provided by SuperiorAPIs. It supports selecting an API, choosing an HTTP method, optionally selecting a scenario template, and configuring request parameters, headers, and query parameters. The node constructs and sends HTTP requests to the SuperiorAPIs platform and returns the API response. It is useful for automating interactions with multiple APIs from SuperiorAPIs in workflows, such as fetching data, submitting forms, or triggering actions based on API responses.

Use Case Examples

  1. Automate data retrieval from a SuperiorAPIs endpoint by selecting the API and method, then processing the returned JSON data.
  2. Use scenario templates to quickly configure complex request bodies for POST, PUT, or PATCH methods.
  3. Send custom headers and query parameters to tailor API requests dynamically within a workflow.

Properties

Name Meaning
Token API access token for authenticating requests to the SuperiorAPIs platform.
API List Name or ID Select the specific API from SuperiorAPIs to call, either from a list or by specifying an ID.
HTTP Method Name or ID Select the HTTP method (GET, POST, PUT, PATCH, etc.) to use for the API call.
Base URI Base URL for the API requests, defaulting to the SuperiorAPIs server but modifiable if needed.
Scenario List Name or ID Optional scenario template to predefine request body parameters for the selected API and method.
Body JSON JSON-formatted request body, either from a scenario template or default structure based on API specification.
API Parameters Parameters for the API call, including query and header parameters, especially when not using a scenario template.
Request Body Fields to include in the request body for POST, PUT, or PATCH methods when not using a scenario template.
Send Query Parameters Flag to indicate whether to send query parameters with the request.
Query Parameters Query parameters specified as key-value pairs or JSON object, depending on selection.
Send Headers Flag to indicate whether to send custom headers with the request.
Headers Custom headers specified as key-value pairs or JSON object, depending on selection.

Output

JSON

  • json - The JSON response returned from the SuperiorAPIs API call.

Dependencies

  • Requires a token credential for authenticating with the SuperiorAPIs platform.
  • Optionally uses an API key credential for additional headers if configured.

Troubleshooting

  • Common issues include missing or invalid token, not selecting an API, or malformed JSON in the request body.
  • Error messages may indicate missing required parameters or failure to parse JSON body; ensure token is provided, API and method are selected, and JSON fields are correctly formatted.
  • Network errors or failure to load scenario templates may require checking internet connectivity and token validity.

Links

Discussion