Integrate with Theobald yunIO via Nintex Gateway

In the root level of your OpenAPI Specification:

1. Add the x-ntx-host property with a value of {{x-ntx-gateway-uri}}.
2. Change the value of the basePath property to /xtension.
   

If your OpenAPI Specification does not have a basePath property, create a new basePath property underneath x-ntx-host, and add a value of /xtension.

For more information on overriding the host value, see x-ntx-host.

Nintex Automation Cloud validates all new Nintex Gateway connections The stored authorization credentials for a connector. using a special validation endpoint The address of a specific resource provided by the third-party API. to make sure the Nintex Gateway instance is available at the URL specified in the connection.

In the paths object:

1. Add a new operation A single request to a third-party API. Operations often become actions in the workflow designer. of /x-ntx-validate.
2. Add a GET HTTP method The HTTP action to perform on the endpoint, such as GET, POST, DELETE, PUT. In defined inside the operation's path object in the OpenAPI specification..
3. Add an operationId of validateConnection.
4. Add the property x-ntx-visibility with a value of internal.
5. Add a response The return from a third-party API after a request has been made by the client. object of 200.
6. Add a response object of default for all other response codes.

For more information on defining operations, see our basic OpenAPI Specification tutorial: Define the operations

To ensure Nintex Automation Cloud validates your Nintex Gateway URL when creating a connection, add the validation URL to the security definition using the x-ntx-connection-validation specification extension.

In the securityDefinition object:

1. Create an object for basic authentication Identifying the API requestor using a username and password passed in the HTTP header., if one doesn't already exist.

See Add basic authentication for help with creating basic authentication security definitions.

2. Inside the basic security definition, add the x-ntx-connection-validation property.
3. Inside the x-ntx-connection-validation property, add the property operationId with a value of validateConnection.

For more information on validation operations, see x-ntx-connection-validation.

To add connection properties to the security definition:

1. Inside the basic security definition, add the x-ntx-connection-properties object.
2. Inside the x-ntx-connection-properties object:
   1. Add a type property with a value of object.
   2. Add a properties object.

We will add the connection properties to this properties object in the next steps.

For more information on defining custom connection properties, see x-ntx-connection-properties.

Your Nintex Automation Cloud tenant may have more than one Nintex Gateway integration. Add the x-ntx-gateway-id connection property so your workflow designers can select from a drop-down list of existing Nintex Gateway integrations when they create their connections.

Inside the properties object of x-ntx-connection-properties:

1. Add an x-ntx-gateway-id object.
2. Inside the x-ntx-gateway-id object:
   1. Add a type property with the value of string.
   2. Add a title property with the value Select Nintex Gateway.

The yunIO service URL is the base URL where the yunIO application expects to receive requests from integrating services.

Add the x-ntx-gateway-xtension-baseurl property to store the yunIO service URL:

Inside the properties object of x-ntx-connection-properties:

1. Add an x-ntx-gateway-xtension-baseurl object.
2. Inside the x-ntx-gateway-xtension-baseurl object:
   1. Add a type property with the value of string.
   2. Add a title property with the value yunIO service URL.
   3. Add a description property with the value Base URL of the yunIO service, including HTTPS://.
   4. Add a pattern property with the value of ^(https?:\/\/[^\/?#]+)(?:[\/]|\/.+|)$.

Add username and password connection properties to collect the username and password that will be supplied to yunIO when making requests.

Inside the properties object of x-ntx-connection-properties:

1. Add a username object.
2. Inside the username object:
   1. Add a type property with the value of string.
   2. Add a title property with the value yunIO username.
3. Add a password object.
4. Inside the password object:
   1. Add a type property with the value of string.
   2. Add a title property with the value yunIO password.
   3. Add a format property with the value password.

Add connection properties for the Active Directory username and password. These credentials will be used by Nintex Gateway to authenticate to your network.

Inside the properties object of x-ntx-connection-properties:

1. Add an x-ntx-gateway-username object.
2. Inside the x-ntx-gateway-username object:
   1. Add a type property with the value of string.
   2. Add a title property with the value Active Directory username.
3. Add an x-ntx-gateway-password object.
4. Inside the x-ntx-gateway-password object:
   1. Add a type property with the value of string.
   2. Add a title property with the value Active Directory password.
   3. Add a format property with the value password.

If your organization does not use Active Directory, you can also authenticate using API keys. See Managed authentication with an API key .

Designate all the connection properties you have added as required so the workflow designer must complete them all when they create a connection to yunIO.

Inside the properties object of x-ntx-connection-properties:

1. Add a required property.
2. For the value of the required property, add an array of the property names of each connection property you created.