Authorization fields

The following table lists the steps to provide authorization details for testing APIs, based on the authorization type applied to the corresponding APIs:
Authorization type Procedure
For APIs protected with API key
  • Select an application from the Applications field.
  • Select API Key from the Authorization type field.
The test request is sent to the API server with the API key of the selected application.
For APIs that require basic authentication
  • Select Basic auth from the Authorization type field.
  • Provide the user credentials and click Update.
The test request is sent with the selected authorization details.
For APIs protected with JWT
  • Select an application from the Applications field.
  • Select JWT from the Authorization type field.

    The JWT tokens available for the selected application appear in the Available tokens section. You can select a token from the list or request for a new one.

  • Click Get new access token icon to get a new access token. The Create new token page appears.
  • Provide the credentials that are associated with the JWT authorization and click Get token.

    The token appears in the Available token section. Validity of tokens is based on the duration that is specified in the API Gateway.

  • Select the created token.
The test request is sent to the API server with the selected token details.
For APIs protected with OAuth
  • Select an application from the Applications field.
  • Select OAuth 2.0 from the Authorization type field.

    The tokens available for the selected application appear in the Available tokens section. You can select a token from the list or request for a new one.

  • Click Get new access token icon to get a new access token. The Create new token page appears.
  • Provide a Token name.
  • Select a Grant type and a scope.
  • Click Get token.
If you select the Authorization code or Implicit grant type, the webMethods API Gateway Resource access approval page appears.
  • Select scopes according to your requirements and click Approve.
  • Provide your API Gateway credentials and click Sign in. You are redirected to the webMethods Developer Portal Try API page. The token appears in the Available token section. Validity of tokens is based on the duration that is specified in the API Gateway.
  • Select the created token.
If you select the Client credentials grant type, then the request token appears without any further action.
  • Select the created token.

The test request is sent to the API server with the selected token details.

For APIs that do not require any authentication
  • Select None from the Authorization type field.

The test request is sent to the API server without any authorization.