Integrations & API

Using Postman
Version 8.0
This documentation is provided under restrictions on use and are protected by intellectual property laws. Except as
expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate,
broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any
means. Reverse engineering, disassembly, or decompilation of this documentation, unless required by law for
interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you
find any errors, please report them to us in writing.

© 2023 Creatio. All rights reserved.

 Table of Contents | 3

Table of Contents

Using Postman 4
Working with requests in Postman 4
Adding a request 4
Setting up the request 6
Executing the request 8
Saving the request 8
Working with request collections in Postman 9
Adding a collection of requests 9
Adding requests to the collection 11
Setting up variables for the request collection 12
Executing the collection of requests 13

© 2023 Creatio. All rights reserved.

 Using Postman | 4

Using Postman
Medium

Postman is a toolset for API testing. It is a development environment that lets you create, test, manage, and
publish API documentation.

Working with requests in Postman consists of the following general stages:

Adding a request

Setting up the request

Executing the request

Saving the request

A collection of requests lets you execute several requests consecutively. Any collection of requests to Creatio
must include a POST request to AuthService.svc and a user request for working with data. Using collections
facilitates faster testing of large sets of requests.

Working with collections of requests in Postman consists of the following general stages:

Adding a collection of requests

Adding requests to the collection

Setting up variables for the request collection
Executing the collection of requests

We recommend using Postman for testing queries when developing integrations with Creatio via OData 3 or
OData 4. More information about working with Postman is available in the Postman documentation.

Working with requests in Postman

Medium

Adding a request
There are two ways of adding a request in Postman:

Open the [ Create New ] tab, then in the [ Building blocks ] click [ New ] –> [ Request ].

© 2023 Creatio. All rights reserved.

 Using Postman | 5

In the dropdown menu of the [ New ] button, click [ Request ].

Populate the fields in the new request window:

New request fields

Field name Description

[ Request name ] The name of the new request.

© 2023 Creatio. All rights reserved.

 Using Postman | 6

Field name Description

[ Request description (Optional) Additional information about the request (optional).
]

[ Search for a collection or Search for an earlier created collection of requests, or create a new
folder ] one.

New request window

Populate the fields and click [ Save ]. The button becomes active only after the [ Search for a collection or folder ]
field is populated.

Setting up the request

To set up the request:

1. Select the request method.

© 2023 Creatio. All rights reserved.
 Using Postman | 7

1. Select the request method.

2. Enter the request string.

3. Set the data format of the request. Go to the [ Body ] tab, select the “ raw ” option and JSON type.

© 2023 Creatio. All rights reserved.

 Using Postman | 8

4. Populate the request body for POST and PATCH methods.

5. Go to the [ Headers ] tab and set the headers.

Headers

Accept: application/json
Content-Type: application/json; charset=utf-8
ForceUseSession: true

Executing the request

To execute a request, click [ Send ].

Saving the request

To save a request, click [ Save ].

© 2023 Creatio. All rights reserved.

 Working with request collections in Postman | 9

We recommend using Postman for testing queries when developing integrations with Creatio via OData.

Working with request collections in

Postman
Medium

Adding a collection of requests

There are two ways of adding a collection of requests in Postman:

Click [ New ] –> [ Collection ] in the [ Building blocks ] of the [ Create new ] tab.

In the dropdown menu of the [ New ] button, click [ Collection ].

© 2023 Creatio. All rights reserved.

 Working with request collections in Postman | 10

On the [ Collections ] tab, click [ + New Collection ].

Populate the fields in the new collection window:

Fields of the new request collection window

Field name Description

[ Name ] The name of the collection.

[ Description ] The description of the collection.

New collection window

© 2023 Creatio. All rights reserved.

 Working with request collections in Postman | 11

Click [ Create ].

Adding requests to the collection

There are two ways of adding a request to a collection in Postman:

Drag and drop an existing request to the collection.

Right-click the name of an earlier created collection, then click [ Add Request ].

© 2023 Creatio. All rights reserved.

 Working with request collections in Postman | 12

Setting up variables for the request collection

Collections enable setting up common variables and parameters for all requests that it contains. To set the
collection variables:

1. Right-click an earlier created collection.

2. Click [ Edit ], then go to the [ Variables ] tab.

3. Create the following variables for the collection:

Collection variables

Variable name Description

BaseURI Creatio application URL.

UserName Creatio application user name.

UserPassword Creatio application user password.

BPMCSRF CSRF protection token.

CollectionName Object collection (database table) name.

Variable values in the [ Initial value ] and [ Current value ] must be duplicated.

© 2023 Creatio. All rights reserved.

 Working with request collections in Postman | 13

Variable values in the [ Initial value ] and [ Current value ] must be duplicated.

Executing the collection of requests

To execute a collection of requests:

1. Click next to the collection name.

2. Click [ Run ].

3. In the [ Run order ] block, select requests to run and set their order (1).

© 2023 Creatio. All rights reserved.

 Working with request collections in Postman | 14

4. Select the [ Save responses ] checkbox (2).

5. Click [ Run ] (3).

Getting data of the request structure elements and the response:

Click the request name.

Click [ View ] –> [ Show Postman Console ] or press [ Alt+Ctrl+C ] on the keyboard.

© 2023 Creatio. All rights reserved.

 Working with request collections in Postman | 15

Select the needed item.

© 2023 Creatio. All rights reserved.