Table of Contents

Introduction

This section describes all the tabs available in the API Connector Builder, which are the OAS, Design, Settings, and Preview tabs.

Properties configuration

OAS

The OAS tab allows you to select an OAS document, an API server and configure security settings if applicable. Configure the following required properties:

...

• Configuration Method: 
  • OpenID Connect Discovery 
  • Custom 
• Authorization Code:
  • OpenID Connect Directory 
  • Get Authorization Code 
• Custom: 
  • Issuer 
  • JSON Web Key Set 
  • Authorization Token Endpoint 
  • Token Endpoint
  • Scopes 
• Client Authentication: Select the client authentication type. 
  • Send as Basic Auth Header 
  • Send credentials in body 
• Headers: 
  • NAME
  • VALUE

Design

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.
  

Preview

The Preview tab allows you to view the API endpoint before publishing it.

...