To make it easier for you to get started with connecting your service to the Marketplace, the most important steps are summarized on this page. More detailed information is linked from here.

1.) Contact:

Are you interested in offering your service on the Marketplace? Please briefly describe what your service should be able to do and fill out our contact form . If you have any questions, please contact us at marketing@onoffice.de. Together we will check whether and on what terms your service can be offered and clarify your questions.

2.) Provide documents and information:

If your service is to be offered in the Marketplace, general information, documents, logos, description texts etc. about your services are required, which are made available to our customers. The required information can be found under Provider registration . Upon receipt, we will add them to the Marketplace. Our product management will request the required information by e-mail at the appropriate time.

3.) onOffice provider customer:

We will create an onOffice customer for you so that you can familiarize yourself with the software. All purchases that customers have made with your service are listed in this provider customer.

You will receive the access data by e-mail. Detailed information about onOffice enterprise can be found in the online help and in the Marketplacesection. Please check whether “Sandbox” is visible in the menu bar at the top right. It is not necessary to create your own Marketplace account in the account management, we will do this for you. Check whether an account has already been set up in the account management . If this is not the case, please contact your contact person in Product Management or it-product-management@onoffice.de.

4.) Payment processing:

Payment processing for your services takes place via the payment provider Mangopay . You will receive an account there, which we will set up for you. The revenue from purchases in the Marketplace can then be transferred to your own account via a pay-out.

5.) Data exchange via API:

The data exchange between onOffice enterprise and your service takes place via API. To use our API, it is advisable to use our API SDK in PHP. Connection in other programming languages is also possible, but then the timestamp and HMAC must be generated yourself. In addition to the general calls to read and write data, there are some special marketplace calls. For security reasons, you must supply the “extendedClaim” parameter with every API call. Further information on the “extendedClaim” can be found here.

6.) Implement activation:

Before customers can use your service, they must first activateit. Information and the customer’s API access data are transferred to you. You save these. The lower part of the activation popup is integrated via iFrame and must be programmed by you.

Program the activation first and then the actual store. Please let us know the URL for activation as soon as possible. This ensures that you can test your store implementation directly.

The easiest way to do this is to use our existing program code and adapt it individually if necessary. You can use the source files for the activation process to obtain the API user data. In the source files for the activation process, the API call Activate provider is called with the transferred data (parameterCacheId) to activate your provider for the customer in the Marketplace.

7.) Integrate the demo store:

The next step is to make your services available in the Marketplace. We already provide code for a demo service that you can use for connection and testing. The demo store gives you the opportunity to make and test payments and purchases within the service. Use the demo store website in PHP as a template for your store. Then your demo service should already be visible under Marketplace >> Overview .

8.) Program and integrate the service:

Next, you program your own service and replace the demo store with your service. The basics from our demo store implementation can be used. Once your service has been completed, let our product management team know. Your service is then checked by our test department and is then released for the production system for customers and can be used. Before that, everything takes place in a sandbox environment in which you can test and simulate purchases. For this purpose, test credit cards are used, the numbers of which you can find at Mangopay . One payment method should already be entered, and you enter further payment methods in the Marketplace account .

9.) FAQ / Notes:

1.) API key (secret) of the Marketplace API user vs. provider secret : Please do not confuse the two different secrets that are used. The secret, also known as the API key, of your API user is explained here . The provider secret is required for the signature and is explained in more detail here .

2.) Do not create your own API user in customer versions: You do not need to create your own API users in the customer versions of onOffice enterprise. In the Marketplace, the API users via which your service exchanges data with onOffice enterprise are automatically created when your service is activated. To retrieve data from your provider customer, however, it is necessary to create an API user . (See point 3.)

3.) We have created your own provider customer so that you can test your service yourself. All purchases that customers have made with your service are also listed in this provider customer. You can perform the functions “Generate additional payment link” and “Cancel transaction” manually via the GUI. These two functions can also be executed via the API in the provider customer with the API calls Generate additional payment link and Cancel transaction.  If you want to use the functions “Generate additional payment link” and “Cancel transaction” automatically via the API, please ask your contact person in onOffice product management / the required API user will then be set up.

4.) Clear identification of a customer: A customer can only be uniquely identified via the combination of customer ID (customerWebId) and user ID (userId). A customer is an instance of the onOffice software that can have many users. customers are often brokerage firms and users are the brokers. The user ID alone is not sufficient.

10.) Support and help:

– Find out here in our technical documentation about the other options you have with the Marketplace.
– If you have any technical questions, please contact our Marketplace support at marketplace-dev@onoffice.de.
– In the online help for Marketplace customers , you will find information on how the Marketplace works and which other providers are already available.
– The API documentation describes which options are available for exchanging data with your service / which data can be queried and written from enterprise.
– The Accounting page links to and summarizes all topics relevant to accounting and financial processing. The remaining topics in the documentation are more relevant for developers.