2022

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Tip
titleExample

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.

...

  • 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.