Business - Configs

The Admin interface handles web service calls from the Admin web gui. The base url for this is at:

/api/business-admin

A JSON file with OpenAPI data about all business-related admin APIs can be downloaded here.

Get environment variables

Get the environment variable related to the Business module (it’s a Paged List APIs, as explained in the introduction):

GET /v1/config/mappings

Returns the environment variables relating to the current module

Status Codes

Returns a Json positive response and environment variables list for the Business module:

[
  {
    Key: "VariableName",      // String
    Value: "VariableValue"    // String
  },
  ...
]

Get default wallet settings

Gets configuration settings about wallet defaults, as specified in the related configuration variables:

GET /v1/config/default-wallet-settings

Gets configuration settings about wallet defaults

Status Codes

Returns a Json positive response and the configuration settings:

{
  IsPrepaid: false,              // Boolean
  MaxTokensPerArticle: 100,      // Int
  MaxMinutesPerArticle: 1000,    // Int
  MaxDistancePerArticle: 600,    // Int
  MaxWalletToken: 300,           // Int
  MaxWalletMinutes: 3000,        // Int
  MaxWalletKm: 1800              // Int
}

Value of the BalanceUnit property can be one of the BalanceUnit enumeration.

The MaxXXXPerArticle properties refere to the max accepted size for the related packages (i.e. MaxTokensPerArticle refers to the token packages) while the MaxWalletXXX variables refers to the max allowed capacity for a wallet balance