Configuration - gotmoby/moby-api-documentation GitHub Wiki
The API can be configured in many ways to meet your needs.
The configuration is set up to accept the configuration given by your user.
If the configuration value is not found in your user then it will look for the configuration value in your organization.
This is helpful if you want to test out a different configuration for just one user and not the whole organization.
Postman Documentation
The previous route location /userconfig is deprecated. You can still view the documentation for those routes here
Get the configuration
Get configuration for your organization
The response contains a JSON object with the keys 'nested' and 'flat'. These are two different outputs of the same configuration. A nested approach is easier for a front end UI to render out the contents of the the configuration. The flat is best for API users.
The output will contain a description, human readable label, some possible values it can have, the type that it can be, the value, and it's default value.
Updating a configuration value
All links to references will point to the organization configuration. If you want to apply it to the user then just swap out the /config/organization with /config/user.
In order to save a configuration value you must specify the full name of the attribute. ex. validation.license.licenseAttributesToCheck not licenseAttributesToCheck.
Attributes Overview
You will need to configure these configuration values to your needs:
- licenseAttributesToCheck
- licenseAttributesToStore
Although the value returned from either of the attributes are integers you can set the the values using identifiers. In a future release they will no longer give integers but identifiers instead.
If you want to be notified when a validation is reviewed with authentication then you will also need to configure
- eventBroadcastAuthentication
- eventBroadcastHmacPrivateKey
- eventBroadcastHmacPublicKey
You can make the API return a successful result on every validation which will allow the API to run the validation in the background. You can check the real result later using the Get Validation route.
- forceSuccessForCustomerResult