Connecting to an API Repository

APIX.XL™ can be connected to an API repository such as APIX.Hub™ or an API Gateway.

The following guide allows the user to connect to the API repository of their choice as well as provides additional information about connecting and logging in to APIX.Hub™.

Connecting to an API Gateway

Connecting to APIX.Hub™

Connecting APIX.XL™ to an API Gateway

The following steps allow the user to connect APIX.XL™ to and API Gateway.

1. Click on the Configure API Gateway button on the APIX.XL ribbon.
2. Select the appropriate Auth Type. Authentication types supported by APIX™ include OAuth, JWT OAuth, and NONE.

NONE
The endpoint that returns the Swagger of APIs does not require authentication.

1. API-Of-APIs Url: The URL that returns either a Swagger definition of an API, an array of Swagger definitions, or an array of URLs that return Swagger definitions of underlying APIs.

OAuth
The endpoint that returns the Swagger of APIs has OAuth authentication.

1. API-Of-APIs Url: The URL that returns either a Swagger definition of an API, an array of Swagger definitions, or an array of URLs that return Swagger definitions of underlying APIs.
2. Token Url: The token endpoint to which apps make a request to get an access token for a user.
3. Client Id: The application ID that is assigned to your app. You can find this information in the portal where you registered your app.
4. Client Secret: The client secret that you generated for your app in the app registration portal.
5. Scope: Resource identifier (app ID URI) of the resource you want.
6. Grant Type: The only grant type currently supported is client_credentials.

JWT OAuth
The endpoint that returns the Swagger of APIs has JWT OAuth authentication.
For more info on OAuth please visit: https://docs.microsoft.com/en-us/azure/active-directory/develop/access-tok.

1. API-Of-APIs Url: The URL that returns either a Swagger definition of an API, an array of Swagger definitions, or an array of URLs that return Swagger definitions of underlying APIs.
2. API-Of-APIs JsonPath: If the response from the API-Of-APIs is not the API Swagger definition but Swagger is contained within a property in the response, enter the JSONPath for that property.
3. Client Id: The application ID that is assigned to your app. You can find this information in the portal where you registered your app.
4. Private Key File: The private key that you use to sign the JWT.
5. Public Cert File: The corresponding public key used to verify the JWT.
6. JWT Body Aud: An app ID or URI that identifies the intended recipient of the token.
7. Token Url: The token endpoint to which apps make a request to get an access token for a user.
8. Scope: Resource identifier (application ID URI) of the resource you want.
9. Resource: The target service or resource to which access is being requested. Its value must be an absolute URI.
10. Grant Type: The only grant type currently supported is client_credentials.
11. ClientAssertionType: This is a request parameter and the value is a fixed string, urn:ietf:params:oauth:client-assertion-type:jwt-bearer.
12. JWT Header Type: This is part of the request header and the value is always JWT.
13. Algorithm: The algorithm that was used to generate the private/public key pair.

3. After all required fields for the selected Auth Type have been filled out, click the REVIEW button.

4. If the provided values are correct, APIX™ will connect to the gateway, fetch and process the Swagger, and display the function-selector screen that will list all available endpoints. For the trial version of APIX™, up to three endpoints can be added as functions in Excel. Select the desired endpoints and click the ADD FUNCTIONS TO EXCEL button.

5. A confirmation popup will display once the functions are added to Excel. Click the OK button.

6. Endpoints from each Swagger are grouped into a category that can be found in the Insert Function screen. For instance, if three endpoints were selected in total and two were part of Swagger A and one was part of Swagger B, the two from Swagger A will display under one category and the one from B will display under a different category in Excel. The category name in this example starts with qs.

Connecting APIX.XL™ to APIX.Hub™

The following steps allow the user to connect APIX.XL™ to APIX.Hub™:

1. Click on Configure APIX Hub on the QUICKSTART APIX HUB section of APIX.XL ribbon.
2. Enter the APIX.Hub hostname and click the Save button.
3. A confirmation popup will indicate that the host was successfully saved. Click the OK button to close the confirmation popup and then exit the hub configuration form.
4. In order to connect to the hub, click the Login APIX Hub button on the APIX.XL ribbon, enter credentials, and click the Login button. A popup message will indicate login success or failure.