Connect to Spark API via Postman

Connect to Spark API via Postman

Public API Documentation

 https://documenter.getpostman.com/view/9179336/SzS7Nk63#74566d1c-a415-46be-b991-da41f8a40569

 

Import collection in Postman (and keep in sync)

 

·      In postman desktop client, click “Import”

 

 

·      Paste the following URL

 

https://api.postman.com/collections/9179336-5b97ee73-30e5-40cf-8873-17b7a110c264?access_key=PMAT-01HGWJ44RMATR7SSM4XYCND9QG

 

·      The collection will appear in your postman workspace

 

Updating the collection 

 

The API endpoint collection / documentation is regularly updated. To get the latest, click on “Import” again, paste the same URL but click “Replace” when prompted. 

 

 

 

Using the API in Postman

 

·      Ensure you are using the right environment in the top right corner 

 

 

 

Environment variables

 

Some local variables need to be edited before the first connection

 

·      Click “Environment quick look” in the top right corner.

 

The quicklook is not very usable. 

 

·      Click the “Edit” button to have the environment variable editor in a full tab 

 

 

·      Fill in the values

 

User_email : your email

User_password : your password 

Client_id : provided by Spark

Client_secret : provided by Spark

 

 

Validate

 

·      Pick one request, for example “Get authenticated user” and press send.

 

In the result window at the bottom you should see your own details

 

 

 

    • Related Articles

    • Swimlanes in Spark (or lack thereof)

      What is it? Spark does not support swimlanes because we believe that Swimlanes are not easy to read. Spark's approach makes processes flow in a rather linear way which is more convenient. Swimlanes diagrams often have lines flowing in all direction ...
    • Manage Process Stylesheets in Spark

      Available in Product Plan: Mapping (1 stylesheet) • Analysis (1 stylesheet) • Management (unlimited stylesheets) Feature available to: Admin (Create stylesheet), Editor (Select stylesheet to use on a process) Stylesheets are one of the tool to create ...
    • Managing Users

      Feature available to: Admin How to access Workspace User Management The User Management screen is accessed via the 'Management' section of the main workspace menu. Here you'll see the total users in your workspace and the breakdown of the numbers of ...
    • How to setup Single Sign On (SSO) with Azure AD

      What is Single Sign On (SSO) Definition: Single sign-on (SSO) is an authentication method that enables users to securely authenticate with multiple applications and websites by using just one set of credentials. Specifically, SSO allows users of your ...
    • Process Mapping Basics

      Mapping your first process You've just created and opened your very first process, but don't know where to start. This article will help you understand and learn the basics of process mapping in Spark! Define the scope of your process Before mapping ...