Step 1: Plugin registration
Each plugin may be registered with (and later unregistered from) the system.
The following table shows the required set of information for each plugin.
Plugin element | Required | Applicability for transport type(s) | Notes |
Transport | Yes | Either gRPC or REST | |
Hostname | Yes | gRPC, REST | Either IPv4 address or a hostname pointing to the latter. Should be resolvable via DNS |
Port | Yes | gRPC, REST | Should be accessible for incoming requests from Bókun |
Path | Optional | REST | Path prefix, e.g. /v1 used for all REST calls. Hostname, port and path combined should fit in 255 characters |
Whether SSL is used | Yes | gRPC, REST | Yes or no |
SSL certificate | Optional | gRPC, REST | Should be provided in .crt format. See this advice on how can this be done |
Shared secret | Optional | gRPC | Arbitrary string, max 2048 characters length |
Basic authentication: username and password | Optional | REST | Arbitrary strings, max 64 characters length each |
Plugin registration can only be done by the Bókun staff. Registration is only done once. No two plugins can be registered on the same {hostname, port, path}.
NOTE: once registered, each plugin will be available for configuration to selected vendors in Bókun. If you wish your plugin to be made available to other vendor(s) than your own, please inform Bókun staff about this. Plugin configurations are per vendor and only visible for the vendor who created the configuration. Plugin is expected to reject calls from Inventory Service if the incoming configuration parameters are unrecognised by the plugin. See Step 3. plugin configuration for more details on configuring the plugin.