---
title: "Spirion Sensitive Data Platform REST API for Reporting"
url: "https://dm0bkdes5q7a2ls.productfruits.help/en/article/sensitive-data-platform-rest-api-for-reporting"
language: "en"
last_updated: "2026-02-17T21:47:57.943Z"
---

# Spirion Sensitive Data Platform REST API for Reporting

Use the Spirion Sensitive Data Platform REST API for reporting. This document has some basic understanding of the cURL application, access to a Bash terminal, and familiarity with executing cURL commands.

## Key Assumptions

It is assumed that the reader of this document has a basic understanding of the **cURL**  
application, access to a **BASH** terminal, and familiarity with executing **cURL** commands.

-   To take full advantage of the API functionality it helps to be comfortable writing scripts and/or coding simple apps.
-   Note that the examples below use **Linux bash shell commands** and **parameters**.
-   Bash can be installed into a Windows 10/11 environment using the Windows Subsystem for Linux (WSL).

See the **Appendix** section for links to additional resources on these concepts if you are unfamiliar with them.

## Step 1: Generate Access Credentials

Generate access credentials using the following steps:

1.  Log into the Spirion Sensitive Data Platform Console with a user account that contains the permission “Manage, REST API.”
2.  1.  If the login fails, verify the permissions of the user's role, found on the Settings > User Management page.
    2.  The **Admin** role has this permission by default.
3.  Navigate to the **User Profile** page by clicking “Settings” in the left menu bar:  
      
    ![](https://cdn-assets.productfruits.com/55a0016a-5d84-47a1-af8c-c0c4d0f4ffcb)
4.  Confirm that the “REST API Access” pane is displayed and click the white button **Generate Access Credentials** next to the section heading "REST API Access."   
      
    ![](https://cdn-assets.productfruits.com/11fd4375-1de2-4a8b-9259-99d4c08dd708)
5.  The **Generated Credentials** dialog appears with both a **Client Id** and **Client Secret**.  
      
    ![](https://cdn-assets.productfruits.com/18b782f1-8c50-46ea-8c32-50ca51864d93)
6.  Click the “Copy To Clipboard And Close” button to copy the “Client ID” and “Client Secret” then paste/store somewhere for later reference, using appropriate security measures to protect this information (the credentials above are not valid).   
      
    **NOTE**: The Client Secret is not available for later retrieval. If you lose it and/or need to generate a fresh set of credentials, you can do so with the “Refresh” option available in the hamburger menu on the right (see screenshot above).
7.  When the pop-up window closes the generated **Client Id** is displayed with some additional details.  
      
    ![](https://cdn-assets.productfruits.com/cb8a3d2e-e511-4a8a-acfe-59d8848a8902)

## Step 2: Generate Authentication Token

Use the following steps to generate the authentication token:

1.  Use the programming/scripting language of your choice to make the following call:

```
curl -X POST 'https://api.{env}-spirion.com/oauth2/connect/token' \ -d 'grant_type=client_credentials&client_id=<ID VALUE>&scope=reporting-rest-api&client_secret=<SECRET VALUE>'
```

1.  1.  Replace `{env}` with the Sensitive Data Platform console environment name that you’re sending the call to.
    2.  Replace `<ID VALUE>` with the unmodified **Client Id** from Step 4, in the procedure above.
    3.  Replace `<SECRET VALUE>` with the unmodified **Client Secret** from Step 4, in the procedure above.

> **NOTE**: The credentials need to conform to URL encoding standards for special characters, so it will be necessary to convert the **Client ID** and **Client Secret** values before plugging them into the command above. 

-   The following bash command is one way to do this (replacing VALUE with the **Client ID** and **Client Secret**, one at a time, to generate a new encoded string for each):

```
printf %s 'VALUE' | jq -sRr @uri
```

-   **Example**: Below is an example of the **Client ID** and **Client Secret** before and after conversion

![](https://cdn-assets.productfruits.com/7aa17cb0-077b-44bc-89b3-d5ab08cf12ff)

-   **Client Id**: BkZLWd420LyN+MQTyfOxlJ0JX/m+pY3QRb5Ufzfzk20=printf %s 'BkZLWd420LyN+MQTyfOxlJ0JX/m+pY3QRb5Ufzfzk20=' | jq -sRr @uri 
-   -   **Output**: BkZLWd420LyN%2BMQTyfOxlJ0JX%2Fm%2BpY3QRb5Ufzfzk20%3D
-   **Client Secret**: sa/7Y1tUp0Csj697DFKmKrWieS0Wj3uzwkyuYidxWzo=printf %s 'sa/7Y1tUp0Csj697DFKmKrWieS0Wj3uzwkyuYidxWzo=' | jq -sRr @uri 
-   -   **Output**: sa%2F7Y1tUp0Csj697DFKmKrWieS0Wj3uzwkyuYidxWzo%3D
-   You may alternatively use cURL’s `data-urlencode` flag as part of the call or some other method via your preferred language/application feature to accomplish this.
-   Below is the same call as above, this time using cURL’s `data-urlencode` flag (note this should be entered all at once if using a CLI):

```
curl -X POST 'https://api.{env}-spirion.com/oauth2/connect/token' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'client_id=<ID VALUE>' \ --data-urlencode 'scope=reporting-rest-api' \ --data-urlencode 'client_secret=<SECRET VALUE>'
```

2\. Confirm response:

A. Credentials entered improperly yields the response "error":"invalid\_client":  
![](https://cdn-assets.productfruits.com/017dcb3f-b34d-47f9-a7a1-f6646151f362)  
B. Entered correctly, an access token is generated for API interactions.

## How to Make/Test API Calls

For any given Sensitive Data Platform environment, a summary of calls is available by navigating to the Spirion Reporting REST API Swagger page:  
**https://api.{env}-spirion.com/reporting/swagger/index.html**

Swagger offers a convenient way to test API calls.  
![](https://cdn-assets.productfruits.com/a00ef037-f3a4-458d-877f-dd209914b5f3)  
Procedure:

1.  From its UI, click the “Authorize” button and type in the word “Bearer” followed by the token generated in the previous step.   
      
    ![](https://cdn-assets.productfruits.com/3a766de4-8ad2-41a6-9be7-39f9dc32b0a6)  
    ![](https://cdn-assets.productfruits.com/bd1b6d70-7b3f-41df-9aaa-1e92a08f2c0e)
2.  For any given API call, click the “Try it out" button to enable input and execution.
3.  Below is a full example of an API call test using Swagger:

![](https://cdn-assets.productfruits.com/08e7ca6b-a892-4701-af8c-d946065a8518)

## Appendix: Additional Resources

-   [cURL in Relation to APIs](https://developer.ibm.com/articles/what-is-curl-command/): An introduction to using cURL for API requests.
-   [cURL Converter](https://curlconverter.com/): Convert the cURL commands from Swagger into other languages.
-   [JWT.io](https://jwt.io/): Inspect the details of your API token.
-   [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install): How to install the Linux subsystem in Windows.