Skip to main content

​
Setting up REST API

​
1. Add integration

Select REST API from the integrations page.

​
2. Configure settings

Fill out the form with the following settings:
FieldRequiredDescription
Base URL✓The main endpoint address of the API that serves as the root for all requests
Authentication✓The authentication type you want to use. See detailed instructions for setting up API auth in our docs on Authentication & authorization
Headers✗List of headers that will be added to requests to your API
Params✗List of query parameters that will be added to requests to your API

​
OpenAPI Specifications

You can upload an existing OpenAPI specification file for your REST API. OpenAPI specs helps your team develop at lighting speed in Superblocks. You’ll get access to interactive docs, autocomplete in REST request forms, data validation, and more when your provide a specification for your API.
Uploading an OpenAPI specification
  1. Select Upload OpenAPI in the top-right corner
  2. From the uploader, select a JSON or YAML file containing your API’s OpenAPI spec (version 2.0 or later)
  3. Click Ok to upload
Once your API’s spec has been uploaded, you can manage your spec and explore docs from the API Specification tab.
Replacing an OpenAPI specification
To replace an API specification, such as to upload a new version, you can click on the button in the top-right labeled with the name of specification, e.g. spec-name.yaml, and upload a new specification.

​
3. Test and save

Click Test Connection to check that Superblocks can connect to your API. After connecting successfully, click Create to save the integration.
REST API connected!
Now you can use REST API in any Application, Workflow, or Scheduled Job.

​
Use REST in APIs

Once your REST integration is created, you can start creating steps in APIs that call your REST API. REST APIs can be used to make HTTP request or to consume server-sent events from your internal API or third-party APIs. To learn more about REST requests in Superblocks, see the Building REST requests guide.

​
Supported OpenAPI specs

Superblocks supports uploading the following specification versions:
  • OpenAPI 3.0 and 3.1
  • Swagger 2.0
Specification files can be provided in any of the following formats:
  • JSON
  • YAML
  • X-YAML