Page History

...

1. An OAS document from an API service provider. 
2. Joget DX 8 Enterprise Edition.

How to

...

instal

1. Download the plugin JAR file from the Joget Marketplace. 
2. Go to Settings > Manage Plugins > Upload Plugin. 
3. Once uploaded, the plugin will be available in your Joget environment.

How to use 

API Connector Builder 

Once you have installed the API, configure an API connection. 

...

Properties Configuration 

...

API Endpoints

Image Modified
POST

Parameters:  

• Name: Name Name of the POST operation API endpoint

• Description: A description of the POST operation API endpoint

• Request Body Input Type: 
  • Payload:  
    • Request Body 
  • Input FIelds: 
    • Field Label
    • Default Value
    • Mode
      • Default 
      • Force Mandatory 
      • Hide Field

...

• Mode:
  • Default
  • Force Mandatory
  • Hide Field

Authenticators 

oauth2

• Grant Type: Select the method the application uses to obtain an access token. 

• Scopes:
  • View allowance templates.
  • Create and update allowance templates.
  • Delete allowance templates.
• Client ID: The Client ID provisioned by the OpenID provider when the client was registered. 

• Client Secret: The Client Secret (password) provisioned by the OpenID provider when the client was registered. 

• Client Authentication: Select the client authentication type. 
  • Send as Basic Auth Header
  • Send credentials in body
• Headers: 
  • NAME
  • VALUE

openId

• Client ID: The Client ID provisioned by the OpenID provider when the client was registered. 

• Client Secret: The Client Secret (password) provisioned by the OpenID provider when the client was registered. 

• Code Challenge Method:
• Callback URL: URL to which Auth0 redirects users after they authenticate. 

Note

Ensure to provide this Callback URL to your OpenID Connect service.

• 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

Plugin information 

The API Connector plugin is part of the Addon Builders API Connector suite, designed to help you create, manage, and secure custom APIs within your Joget platformyour Joget platform. The available API elements cover a wide range of functionality, from managing users to handling forms and processes. 

...