DBSync Cloud Workflow (iPaaS)

2022

Page tree
Skip to end of metadata
Go to start of metadata

API

Swagger Interactive UI: http://<env>.mydbsync.com/<version>/api-docs/v2/partner#!/default/all.

REST API Endpoint: http://<env>.mydbsync.com/<version>/appcode/v2/partner.

Please reach out to your Account Manager to get access to API for developing and production use.

Example

If connecting to our Staging (Pre-Release) for development, use:

  • Environment: staging
  • Version: appcenter-2-2

Corresponding URLs will be

All requests and responses require "POST" method calls with valid API environment and version. All request and responses are in JSON.

ReST API Methods:

Explore API

Use the Swagger API Explorer to try out the API's

https://<env>.mydbsync.com/<appcenter-version>/api-docs/v2/partner.

Available methods for Partner API v2 are:

  • registerUser: registers a user with DBSync license manager. The registered user will count against the license quota applied to the partner application Key.
    Parameters:
    partnerAppKey (Required): API application key.
    partnerAppToken (Required): API application Token.
    endUserCompany (Required): User’s Company Name.
    endUserName (Required): uniquely identifiable username. We recommend using partner application Username to uniquely identify the user across our applications.

Returns:
Newly created user:

  • unregisterUser: This api is used for unregister an existing user from a partner application. This reduces the current count of active users. But, at the same time, it does not change the annual quota for licensed users of the partner application.
    Parameters:
    partnerAppKey (Required): API application key.
    partnerAppToken (Required): API application Token.
    endUserCompany (Required): User’s Company Name.
    endUserName (Required): uniquely identifiable username. We recommend using partner application Username to uniquely identify the user across our applications.

Returns:
Success unregistering or failure with error:

  • authenticateUser : Authenticates an existing user for the partner application to check if they have valid license to run the integration.
    Parameters:
    partnerAppKey (Required): API application key.
    partnerAppToken (Required): API application Token.
    endUserCompany (Required): User’s Company Name.
    endUserName (Required): uniquely identifiable username. We recommend using partner application Username to uniquely identify the user across our applications.

Returns:
License Detail for the user:

  • licenseDetails : Fetches license details of all (or single, using filter) users registered as a partner.
    Parameters:  
    partnerAppKey (Required): API application key.
    partnerAppToken (Required): API application Token.
    endUserCompany (optional): User’s Company Name.
    endUserName (Required): uniquely identifiable username. We recommend using partner application Username to uniquely identify the user across our applications.

Returns:
License details of users if, the endUserCompany is not set; or, it returns only licenses for particular users of that company.
 

  • No labels