Build your first custom connector
With the Nintex Xtensions framework, you can create Xtensions to extend Nintex Workflow beyond the many high-value connectors Nintex provides out of the box. By writing and uploading an OpenAPI Specification, you can integrate any service or data source with a RESTful API into your workflow. The advantage of using the OpenAPI Specification to define Xtensionis there’s no bus, no middleware and no executing code: you can instantly generate a user interface for your integration inside the Nintex Workflow designer.
Xtensions are used only in Nintex Workflow. If you do not have a Nintex Workflow tenancy, more information and a request for a 30 day trial is available here: http://www.nintex.com/workflow-platform/nintex-workflow-cloud.
What is the OpenAPI Specification?
The OpenAPI Specification (OAS), formerly known as the Swagger specification, is an open standard for writing API definitions in a way that is easily readable by both humans and software. Because of its readability, extensibility and ease of editing, OpenAPI Specification is rapidly being adopted as the standard for API description across the industry.
Nintex Xtensions uses the OpenAPI Specification to integrate apps, services and data sources into workflows to make integrating with Nintex as fast and simple a process as possible.
OpenAPI Specifications for Nintex Xtensions must be written in JSON. We recommend Xtensions are written by developers or users with an in-depth understanding of APIs.
Note: Nintex Xtensions currently supports OpenAPI Specification 2.0 only.
Looking to upload a product or service's published OpenAPI Specification? See Import a third-party specification.
Tools and resources you can use
Several tools exist to help create and test your OpenAPI Specifications.
The Nintex OpenAPI Specification quick reference file
You can quickly build an OpenAPI Specification by copying and pasting sections from our quick reference file. Sample code is supplied for parameters, authentication methods, Nintex Specification Extensions and other functionality.
OpenAPI Specification quick reference
The Swagger.io editor
The Swagger.io editor allows you to create, edit and validate OpenAPI Specifications, and view the resulting API in an interactive format. The interactive format allows you to test that your API operations have been described correctly, and respond as expected. You can also quickly convert from YAML to JSON format for use in Nintex Xtensions.
Studio.Restlet
The Studio.Restlet editor allows you to build an OpenAPI Specification by filling in fields to create operations and responses. Because it is all created with forms, you never have to read the underlying code, allowing people who are unfamiliar with JSON to create and edit their own OpenAPI Specifications.
Open the Studio.Restlet editor.
References
See the Nintex Xtensions Glossary for explanations of terms used in this documentation.
You can also refer to the OpenAPI Specification definition for more information.