Find a suitable API
When creating an OpenAPI Specification A standard, language-agnostic description of RESTful APIs that can be read by both humans and machines. Formerly known as Swagger. to integrate an app, you must make sure the API A programming interface that defines how a software platform can receive and respond to requests from other software platforms. can be supported by Nintex Xtensions. To be supported, an API must:
- Be RESTful Representational State Transfer: a style of software architecture that separates state and functionality into distributed resources, with each resource uniquely addressable, typically using HTTP commands. RESTful applications are usually stateless and support caching.
- Communicate over HTTP Hypertext Transfer Protocol: the protocol by which websites and APIs communicate over the internet. or HTTPS Hypertext Transfer Protocol Secure: the protocol by which websites and APIs communicate securely over the internet.
- Authenticate Confirming the identity of the person or service requesting access to a resource (Authorization) and confirming they have permission to complete that request (Authorization). These terms are often used interchangeably. Examples include username and passwords, API keys, and OAuth2.0 flows. with either:
- no authentication
- basic authentication Identifying the API requestor using a username and password passed in the HTTP header.
- API key authentication An predefined string passed in an API request, either inside the header or as a request parameter, to identify and/or authenticate the requester.
- OAuth 2.0 An authorization protocol that allows a user to grant access to a third-party account without revealing their credentials to the requesting software.
- Accept parameters A piece of information passed to a third-party API during a request. compatible with version 2 of the OpenAPI Specification
- Return the response The return from a third-party API after a request has been made by the client. data in JSON JavaScript Object Notation: a data format based on JavaScript that is commonly used for API request parameters and responses.
What data types are supported?
Nintex Automation Cloud supports the following data types, as detailed in version 2 of the OpenAPI Specification:
|
boolean |
True or false. |
|
integer |
A number with no fraction or exponent component. |
|
number |
A number that may contain a fraction or exponent component. |
|
string |
A JSON string. |
|
array |
A JSON array. Requires complex object support. See Send arrays or complex objects. |
|
object |
A JSON object. Requires complex object support. See Send arrays or complex objects. |
|
file |
As multipart/form-data. For other file formats, see Manage files in your workflows. |
For example definitions of these data types, see the OpenAPI Specification quick reference.
Tip: If you want to connect an unsupported API, you can create a small piece of code called a serverless function A cloud provider service that allows you to run code without provisioning and managing a web server to host it. Examples include Amazon Web Services and Microsoft Azure. to pre-process unsupported operations A single request to a third-party API. Operations often become actions in the workflow designer. and responses between Nintex Automation Cloud and the API. This is explained in more detail further on.
OpenAPI Specifications must be written in JSON to be imported into Nintex Automation Cloud. You can convert specification formats from YAML A human-readable file format similar to JSON that uses indentations instead of braces and brackets. OpenAPI Specifications provided by other service providers may sometimes be written in YAML instead of JSON. Nintex Xtensions supports JSON only. to JSON using the Swagger.io editor.
Looking to upload a product or service's published OpenAPI Specification? See Import a third-party specification.
Note: Events A task or occurrence that can trigger the start of a workflow, such as a form submission or third-party API event. are not yet supported by Nintex Xtensions. For more information on what is currently supported, see Limitations and Known Issues.