...
This section describes all the tabs available in the API Connector Builder, which are the OAS, Design, Settings, and Preview tabs.
Properties configuration
...
Depending on the Authentication Method selected, configure the following properties:
- Grant Type: Select the method the application uses to obtain an access token.
...
In the Design tab, all available API endpoints are listed in the API Connector Builder palette. After dragging and dropping an endpoint to the canvas, that canvas can be configured depending on the method that endpoint uses. Refer to API Endpoints for more information.
Settings
The Settings tab allows you to modify the API ID, name and description if required.
- ID: The API connector ID.
- Name: The name of the API connector.
- Description: The description of the API connector.
- Logo: Assign a logo for the API connector.
- Debug Mode: Show relevant debug in the server log for debugging purposes.
...
The Preview tab allows you to view the API endpoint before publishing it.
- Select Operation: Select an API endpoint.
- Description: The API endpoint description.
- Depending on the operation selected, you will preview:
- id: Available with the GET and DELETE methods. Specify the ID of the item to fetch or delete.
- Payload: Available with the POST and PUT methods. The structure of the API in JSON or YAML format. You can add many more details, like authentication methods, request parameters, query parameters, or more complex schemas.
...