They authenticate themselves with the entered API key and the transferred token. You must call the API function for unlocking the provider (ACTION_ID_DO, ‘unlockProvider’) and pass the parameter parameterCacheId to it (see unlockProvider.js in the code examples). The parameter parameterCacheId parameter contains internal information that was stored in the parameter cache.
In case of success “active” should be returned, in case of error an error message should be returned for the user. (see unlockProvider.js in the code examples).
The status changes from “Inactive” to “Active” if successful.
The API key is the secret of your API user at the customer site. The customer, who wants to use your services, copies the API key into their iFrame during the activation process, thereby transferring it to you and giving you rights to access their onOffice software. Therefore please save the API key and the token for each customer. Many services in the Marketplace require read or write access to certain resources in onOffice enterprise in order to function. Example Floor plan optimization: Customer orders floor plan in the Marketplace for a specific property (provider must have read access to property or floor plan), provider creates floor plan, provider plays back optimized floor plan (provider must have write access to property).