API Documentation

 

 

Getting Started

Welcome to Pulsora’s API documentation. This documentation outlines the APIs provided by Pulsora, the all-in-one enterprise sustainability management platform, helping companies collect, report, and improve their ESG and sustainability. These APIs enable seamless integration with Pulsora’s services. Please follow the guidelines below to utilize our APIs effectively.

Authentication

  • Pulsora APIs are accessible by customers and partners using their account information. All Pulsora APIs require authentication. 
  • To get started with authentication, please contact Pulsora for the required input data, including ”Client secret”, “username”, and “password” that can be used to request the access token.

Get Access Token

Endpoint:POST https://prod.pulsesg.com/kc/realms/PulsESG/protocol/openid-connect/token

Headers:
Content-Type: application/x-www-form-urlencoded

Parameters:
‘client_id’: PulsESG-client-app
‘grant_type’: password
‘client_secret’: Your client secret
‘username’: Your username
‘password’: Your password

Request Example
POST https://prod.pulsesg.com/kc/realms/PulsESG/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencodedclient_id=PulsESG-client-app&grant_type=password&client_secret=<your_keycloak_client_secret>&username=<your_username>&password=<your_password>

Response Example (200 OK)
{
“access_token”: “<access_token>”,
“expires_in”: 36000,
“refresh_token”: “<refresh_token>”,
“token_type”: “Bearer”
}

List of Pulsora APIs

DataSource File Upload API  (Swagger Documentation Link)

        • Pulsora Data Sources allows bringing sustainability-related data from disparate internal and external sources to provide users with a unified view.  
        • A Data Source is a module for seamlessly integrating data into the platform, whether you’re leveraging automated systems, manual file uploads, or FTP file transfers.
        • This API allows you to upload files into existing Pulsora Data Sources.

Endpoint:
POST https://prod.pulsesg.com/api/papis/datasource/uploadFile


Headers:
Content-Type: multipart/form-data
Authorization: Bearer <access_token obtained from the authentication step>


Parameters:
file: The file to be uploaded
dataSourceName: Your data source name


Request Example:
POST https://prod.pulsesg.com/api/papis/datasource/uploadFile
Content-Type: multipart/form-data
Authorization: Bearer <access_token>file=<file_to_be_uploaded>&dataSourceName=<your_data_source_name>


Response Example (200 OK):
Successfully uploaded file: <file_name>
Note: Tools like curl, Swagger, and Postman will properly format the HTTP request with the file data in the request body.

Error Handling

  • In case of errors, the API will return appropriate HTTP status codes along with error details in the response body.
  • Common status codes include 400 Bad Request, 401 Unauthorized, and 500 Internal Server Error.

Support and Community

  • Was this documentation useful? Please share your feedback.
  • Also, if you have any questions or need assistance, please contact our support team at support@pulsora.com.