Page History

...

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

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

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

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

...

Available methods for Partner API v1 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 Newly created user:

• unregisterUser: This api is used for unregister an existing user for from a partner application. This reduces the current count for of active users but . But, at the same time, it does not change the annual quota for licensed users for 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 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 License Detail for the user:

• licenseDetails : Fetches license details of all (or single, using filter) users registered for the 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 for of users if, the endUserCompany is not set; or, it returns only licenses for particular users for of that company.