DBSync Cloud Workflow (iPaaS)

2022

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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

API

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

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

Please reachout 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/v1/partner

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 created user

  • unregisterUser: This api is used for unregister an existing user for a partner application. This reduces the current count for active users but does not change the annual quota for licensed users for 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 for the 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 users if endUserCompany is not set or returns only licenses for particular users for that company.
 

  • No labels