Migrate Public API

Overview

Syniti Migrate Public API enables organizations to automate enterprise data migrations at scale. You can programmatically orchestrate the entire migration lifecycle—from project setup and datasource integration to mapping, testing, and deployment—while maintaining complete traceability of data transformations and ensuring compliance requirements are met.

The API provides comprehensive control across project governance, data integration, transformation, testing automation, and deployment. You can create migration projects, register datasources, define business data mappings, and execute snapshot-based replication jobs.

Migrate Public API is tenant-specific and supports the following authentication types:

• SKP OAuth 2.0 Bearer Token

• API Key

To access public API reference documentation, replace <tenant_name> in the following URL with your tenant name: https://<tenant_name>.migrate.syniti.com/swagger/index.html

SKP OAuth 2.0 Bearer Token

You can authenticate using OAuth 2.0 with the Client Credentials grant type. The authentication process is a two-step workflow:

1. Obtain a Bearer Token

2. Use the Bearer Token in Migrate Public API Requests

Prerequisites

Raise a support ticket to configure an API User account to enable the API to perform tasks for your tenant. This account provides credentials for API operations. When those operations are completed, assets indicate that the API User completed them.

curl -X POST https://api.syniti.com/oauth2/tokens \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

{
  "access_token": "eyJhbG.............................", 
  "expires_in": 900
}

Note

Enter the appropriate endpoint based on your region.

• Americas: https://api.syniti.com/oauth2/tokens

• EMEA: https://api.syniti.eu/oauth2/tokens

• Australia: https://api.syniti.au/oauth2/tokens

• Canada: https://api.syniti.ca/oauth2/tokens

Use the Bearer Token in Migrate Public API Requests

Include the bearer token in the concento-authtoken header for all API calls.

Header Format

concento-authtoken: Bearer {access_token}

Example API Call

curl -X POST https://<your-tenant>.migrate.syniti.com/vl/testing-datasets \ 
  -H 'concento-authtoken: Bearer eyJhbG.............................' \
  -H 'Content-Type: application/json' \ 
  -d '{ 
    "name": "BD9 - Sales Order Creation: BD9", 
    "description": "BD9 - Sales Order Creation", 
    "test_dataset_id": "TDS-01KC2JK4JJTZD0ZQP07JDDFPHV", "test_created_by": "Bob Jones", 
    "test_created_on": "2020-01-01", 
    "test_updated_by": "Bob Jones", 
    "test_updated_on": "2020-01-01" 
}'

Note

Bearer tokens expire after 15 minutes. Always refresh your token before expiration to avoid 401 Unauthorized errors during API operations. If needed, implement automatic token refresh when receiving unauthorized errors.

Create a Migrate Public API Token

Note

Previously known as the report refresh token, the Migrate Public API Token now supports integration with any external system. Both the  report-refresh-token and api-key headers are accepted for backward compatibility, though api-key is the recommended approach for new implementations.

This token, which is specific to the user and the tenant, is used to access Migrate API and integrate with external systems, for example, accessing Data Services systems for Migration Reporting. The reporting API must be secure. The communication between Data Services and the reporting API must have a type of password access for security. The token is that security.

To create a Migrate Public API token:

1. Click the User Profile icon and select My Profile.

2. Under Migrate Public API Token, click the Create New Token button to generate a new API token. This token GUID can be used in Data Services to provide security for running reporting.

3. Click the Continue button on the Validation warning.

   Note

   Store this Migrate Public API token in a secure location, as you cannot view the token after it is initially created. Migrate hashes this token against the token stored, and if they don't match, it does not run the reports in the integrated systems.

   This new Authorization Policy is in effect only in the Migration Reports Refresh area. If a user has authenticated via a token, then they are allowed to hit these endpoints.. That is the only area of Migrate that these tokens grant access to.

   Note

   In Data Services, you must add this token in the User Specific Variables section.

Use the Public API Token

You can use this token to authenticate API requests by including it in the HTTP header:

• Recommended: Use the api-key header: api-key: <your-token>

• Legacy: Use the report-refresh-token header: report-refresh-token: <your-token>

Both headers are supported for backward compatibility.

Data Services Integration (Legacy)

1. In Data Services, create the WebService Datastore.

2. Add the Migrate Public API Token to the Standard HTTP Header Fields section as shown below. After clicking the detail for the Standard HTTP Header Fields option, paste the Migrate Public API Token into the Default Value field.

   • Header Name: api-key (or report-refresh-token for legacy systems)

   • Default Value: <your-public-api-token>

     

3. Click OK.

Related Articles

Knowledge Platform API