Elements of the API

RESTful endpoints can receive HTTP methods that include verbs such send Get, Post, Put, Delete, and so on. You can refer to the end-point reference for each endpoint to find out the expected method. For more information, see REST Resources.

The URL for the endpoint, also known as the URI (for Uniform Resource Identifier) is structured to handle an incoming request and pass specific information to the endpoint necessary to prepare the return payload. The endpoint is a connection point exposed via HTTP of a live function.

The URL uses the following format:

[1]https://[2]yourtenant.nintexO365.com/[3]api/v1/[4]endpoint/[5]identifiers

The URL has the following elements:

1. Uses a secure hypertext transfer protocol (https) connection.
2. The API call uses a specific URL provided to you by Nintex. This URL is different than the URL of your SharePoint tenant. Nintex will provide to you an API URL for your tenant. For more information, see Get your API key and API base URL.
3. The API version number.
4. This element specifies if it is the workflow or forms API.
5. Identifiers such as the ListID, ContentypteID, and workflowID are used by the API to specify the workflow or form.

The headers in a REST call are key-value pairs separated by a colon and terminated by a new line. Typically headers start on the second line of a call and are part of the HTTP protocol. They can include keys such as cookie, content-type, and date.

You must include headers with your call to interact with the API. The specific calls will depend on the endpoint you are trying to contact, however, some common headers include:

• Authorization (required). The authorization header contains a cookie and security token you will need to construct using a Windows PowerShell script. For more information see Create your authentication token.
• Api-Key (required). The API Key is a 22 digit number that you will send as a header in your request. Nintex will provide to you an API key for your tenant. For more information, see Get your API key and API base URL.
• ContentType (required). This is "application/json"
• Accept (optional). If you are sending a request payload, for instance for the accepteduse endpoint, you will need to specify "application/json" as the accept header.
• Environmental header (optional). Your tenant administrator may have configured a required header. This header will have a specific key and value. In the image, a key of Test-Environment has a value of 03. Check with your tenant administrator to find out if you they have configured a required header.