Data API

About Synkrato Data API

Synkrato REST API enables seamless interaction between external applications and Synkrato’s platform. Through the API, external systems can securely access, retrieve, and update data stored within Synkrato.

The API follows RESTful principles and uses token-based authentication for secure access, ensuring data integrity and protection. Whether you're integrating with third-party services or building custom solutions, Synkrato’s API provides the flexibility to manage your data programmatically

Security

Synkrato takes security seriously, employing industry-standard protocols to safeguard your data. API access requires token-based authentication, ensuring that only authorised users can interact with your data.

Tokens are encrypted and expire after 180 days, reducing the risk of unauthorized access.

Additionally, all API requests are transmitted over HTTPS, ensuring data is encrypted in transit. To prevent abuse, the API enforces a rate limit of 3 requests per second, maintaining optimal performance and security for all users.

• Token based authentication

• ID/Access token API is being revamped internally (Will be released in future)

Token generation

Admins have the ability to create new tokens by logging in as a site admin and generating tokens from the Customer Details page within the Synkrato Platform. This allows for easy token management, ensuring continued secure access when needed

All Personal Access Token are invalid when Access Token Private Key is changed in the API Server. Please recreate new token with new token

Sample Code

Below is an example of how to make an HTTP GET request to the Synkrato API using curl with a Bearer token for authentication.

1. curl Example

Copy

curl -X GET "https://app.synkrato.com/data/api/v1/health/readiness" \
     -H "Authorization: Bearer your_token_here" \
     -H "Content-Type: application/json"

2. Node.js Example (using axios)

Copy

const axios = require("axios");
const config = {
  method: "get",
  url: "https://app.synkrato.com/data/api/v1/your-endpoint",
  headers: {
    Authorization: "Bearer your_token_here",
    "Content-Type": "application/json",
  },
};
axios(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.error(error);
  });

In this example:

• Replace https://app.synkrato.com/data/api/v1/health/readiness with the actual API endpoint you're targeting.

• Replace your_token_here with the token generated from the Synkrato Platform.

This request retrieves data from the specified endpoint using the Bearer token for secure access.

Swagger