Get License From License Server
using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"OwnerName\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({OwnerName: '<string>'})
};
fetch('http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "53294",
CURLOPT_URL => "http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'OwnerName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer"
payload = { "OwnerName": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({OwnerName: '<string>'})
};
fetch('http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Reason": "<string>",
"CanBeActivated": true,
"New": {
"CompanyName": "<string>",
"SerialNr": "<string>",
"OwnerName": "<string>",
"OwnerDescription": "<string>",
"NextCheckDate": "2023-11-07T05:31:56Z",
"MaintenanceDate": "2023-11-07T05:31:56Z",
"AdminWarningDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"GraceDate": "2023-11-07T05:31:56Z",
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"LicenseUrl": "<string>",
"LicenseVersion": "<string>",
"DeploymentType": 123,
"ProductType": "<string>",
"ProductDescription": "<string>",
"ModuleLicenses": [
{
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
}
],
"PublicKey": {
"OwnerName": "<string>",
"SignDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"Key": {
"P": "aSDinaTvuI8gbWludGxpZnk=",
"Q": "aSDinaTvuI8gbWludGxpZnk=",
"G": "aSDinaTvuI8gbWludGxpZnk=",
"Y": "aSDinaTvuI8gbWludGxpZnk=",
"J": "aSDinaTvuI8gbWludGxpZnk=",
"Seed": "aSDinaTvuI8gbWludGxpZnk=",
"Counter": 123
},
"Signature": "<string>"
},
"Signature": "<string>"
},
"Current": {
"CompanyName": "<string>",
"SerialNr": "<string>",
"OwnerName": "<string>",
"OwnerDescription": "<string>",
"NextCheckDate": "2023-11-07T05:31:56Z",
"MaintenanceDate": "2023-11-07T05:31:56Z",
"AdminWarningDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"GraceDate": "2023-11-07T05:31:56Z",
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"LicenseUrl": "<string>",
"LicenseVersion": "<string>",
"DeploymentType": 123,
"ProductType": "<string>",
"ProductDescription": "<string>",
"ModuleLicenses": [
{
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
}
],
"PublicKey": {
"OwnerName": "<string>",
"SignDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"Key": {
"P": "aSDinaTvuI8gbWludGxpZnk=",
"Q": "aSDinaTvuI8gbWludGxpZnk=",
"G": "aSDinaTvuI8gbWludGxpZnk=",
"Y": "aSDinaTvuI8gbWludGxpZnk=",
"J": "aSDinaTvuI8gbWludGxpZnk=",
"Seed": "aSDinaTvuI8gbWludGxpZnk=",
"Counter": 123
},
"Signature": "<string>"
},
"Signature": "<string>"
},
"ExtendedModuleLicenses": [
{
"New": {
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
},
"Current": {
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
},
"NumberOfLicensesInUse": 123,
"NumberOfLicensesFree": 123,
"NumberOfLicensesAdded": 123,
"NumberOfLicensesNewTotal": 123,
"NumberOfLicensesNewFree": 123,
"NumberOfLicensesTotal": 123
}
],
"AccumulatedNextCheckDate": "2023-11-07T05:31:56Z"
}Get License From License Server
NsApiSlow threshold: 5000 ms.
Get License From License Server
using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"OwnerName\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({OwnerName: '<string>'})
};
fetch('http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "53294",
CURLOPT_URL => "http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'OwnerName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer"
payload = { "OwnerName": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({OwnerName: '<string>'})
};
fetch('http://localhost:53294/api/v1/Agents/License/GetLicenseFromLicenseServer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Reason": "<string>",
"CanBeActivated": true,
"New": {
"CompanyName": "<string>",
"SerialNr": "<string>",
"OwnerName": "<string>",
"OwnerDescription": "<string>",
"NextCheckDate": "2023-11-07T05:31:56Z",
"MaintenanceDate": "2023-11-07T05:31:56Z",
"AdminWarningDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"GraceDate": "2023-11-07T05:31:56Z",
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"LicenseUrl": "<string>",
"LicenseVersion": "<string>",
"DeploymentType": 123,
"ProductType": "<string>",
"ProductDescription": "<string>",
"ModuleLicenses": [
{
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
}
],
"PublicKey": {
"OwnerName": "<string>",
"SignDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"Key": {
"P": "aSDinaTvuI8gbWludGxpZnk=",
"Q": "aSDinaTvuI8gbWludGxpZnk=",
"G": "aSDinaTvuI8gbWludGxpZnk=",
"Y": "aSDinaTvuI8gbWludGxpZnk=",
"J": "aSDinaTvuI8gbWludGxpZnk=",
"Seed": "aSDinaTvuI8gbWludGxpZnk=",
"Counter": 123
},
"Signature": "<string>"
},
"Signature": "<string>"
},
"Current": {
"CompanyName": "<string>",
"SerialNr": "<string>",
"OwnerName": "<string>",
"OwnerDescription": "<string>",
"NextCheckDate": "2023-11-07T05:31:56Z",
"MaintenanceDate": "2023-11-07T05:31:56Z",
"AdminWarningDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"GraceDate": "2023-11-07T05:31:56Z",
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"LicenseUrl": "<string>",
"LicenseVersion": "<string>",
"DeploymentType": 123,
"ProductType": "<string>",
"ProductDescription": "<string>",
"ModuleLicenses": [
{
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
}
],
"PublicKey": {
"OwnerName": "<string>",
"SignDate": "2023-11-07T05:31:56Z",
"ExpiryDate": "2023-11-07T05:31:56Z",
"Key": {
"P": "aSDinaTvuI8gbWludGxpZnk=",
"Q": "aSDinaTvuI8gbWludGxpZnk=",
"G": "aSDinaTvuI8gbWludGxpZnk=",
"Y": "aSDinaTvuI8gbWludGxpZnk=",
"J": "aSDinaTvuI8gbWludGxpZnk=",
"Seed": "aSDinaTvuI8gbWludGxpZnk=",
"Counter": 123
},
"Signature": "<string>"
},
"Signature": "<string>"
},
"ExtendedModuleLicenses": [
{
"New": {
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
},
"Current": {
"OwnerName": "<string>",
"ModuleName": "<string>",
"ModuleDescription": "<string>",
"ModuleTooltip": "<string>",
"ModuleVersion": "<string>",
"LicenseType": "Unknown",
"Unrestricted": true,
"AllowedUserType": "Unknown",
"NumberOfLicenses": 123,
"ExtraFlags": 123,
"ExtraInfo": "<string>",
"SortOrder": 123,
"IsHidden": true,
"PrerequisiteModuleName": "<string>",
"Signature": "<string>"
},
"NumberOfLicensesInUse": 123,
"NumberOfLicensesFree": 123,
"NumberOfLicensesAdded": 123,
"NumberOfLicensesNewTotal": 123,
"NumberOfLicensesNewFree": 123,
"NumberOfLicensesTotal": 123
}
],
"AccumulatedNextCheckDate": "2023-11-07T05:31:56Z"
}Authorizations
SuperOffice username:password are passed in Base64-encoded.
You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.
SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/
passing in the application id and redirect URL.
SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)
https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f
You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.
FlowImplicit
- Authorization URL
- https://online.superoffice.com/login/common/oauth/authorize
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
OwnerName
GetLicenseFromLicenseServer: