Quick Start

You can quickly and easily export, import, migrate, save, and publish workflows from Nintex Workflow for Office 365 by using the Nintex Workflow for Office 365 REST API. The quick start provided here demonstrates the REST API, by walking you through the steps needed to export a Nintex workflow from SharePoint Online.

Exporting your first workflow

Here are the steps you'll need to dive right in and export your first workflow, using the REST API and Visual Studio:

  1. Get your SharePoint Online site, with access to a Nintex workflow
  2. Get the right SharePoint permissions
  3. Get your API key and API URL
  4. Get your SharePoint authentication cookie
  5. Export a workflow

Get your SharePoint Online site, with access to a Nintex workflow

Before you can do anything else, you need to have access to a site on a SharePoint Online tenancy, and access to at least one site workflow or list workflow on that site.

Contact your SharePoint administrator to get access to a site and a workflow.

Get the right SharePoint permissions

Next, you'll need to have the right SharePoint permissions to interact with the Nintex site or list workflows that are associated with your SharePoint site. Without this, you can't authenticate our REST API with your SharePoint site.

Contact your SharePoint administrator to get the right SharePoint permissions. You'll need to be a member of a role in SharePoint that has the Manage Web permission.

Get your API key and API URL

Once that's done, you need to request your API key and API URL from Nintex. The API key authorizes you to invoke the REST resources included with the REST API. You will need to use the API URL to connect to your API endpoints.. Without these, you can't authorize the REST API with your SharePoint site. You'll include the API key as a header value in every request that uses the REST API, as described in Authentication and authorization. You will need to use the API URL as the base URL described in Base URL.

Contact your Nintex representative to request an API key for the REST API.

Get your SharePoint authentication cookie

Once you have the right SharePoint permissions, you can get an authentication cookie from SharePoint that authenticates our REST API, by using your credentials for use with a specific SharePoint site. Authorization cookies expire, so get an authorization cookie only when you're ready to use the REST API.

You can use the code examples included in Authentication and authorization to get your SharePoint authentication cookie.

Export a workflow

You can perform a number of different operations, such as exporting an existing workflow or importing a new workflow, with the REST API. You'll use the Export a workflow operation to export your workflow to an export file, for later use.

You can use the code example included in Exporting workflows to export a workflow.

Next steps

The Guide provides practical information and examples for each REST resource and operation included with the REST API. Experiment with the examples provided in the Guide to get a better idea about how to use the REST API.

The API Reference contains an overview of the technical information you'll need to use the REST API, as well as detailed reference information about the REST resources, data types, request and response bodies, and other elements included with the REST API. The API Reference is the best place to answer technical questions about implementing the REST API.