Um Ihnen den Einstieg bei der Anbindung Ihres Services an den Marketplace zu erleichern, sind auf dieser Seite die wichtigsten Schritte zusammengefasst. Ausführlichere Informationen sind von hier aus verlinkt.

1.) Kontaktaufnahme:

Haben Sie Interesse, Ihren Service im Marketplace anzubieten? Beschreiben Sie kurz was ihr Service können soll und füllen dazu bitte unser Kontaktformular aus. Bei Fragen kontaktieren Sie uns bitte unter marketing@onoffice.de. Zusammen prüfen wir, ob und zu welchen Konditionen Ihr Service angeboten werden kann und klären Ihre Fragen.

2.) Dokumente und Informationen bereitstellen:

Wenn Ihr Service im Marketplace angeboten werden soll, werden allgemeine Informationen, Dokumente, Logos, Beschreibungstexte etc. über Ihre Services benötigt, die unseren Kunden zur Verfügung gestellt werden. Die benötigten Informationen sind unter Anbieteraufnahme zu finden. Nach Erhalt pflegen wir diese im Marketplace ein. Unser Produktmanagement wird zum passenden Zeitpunkt die benötigten Informationen per Mail anfordern.

3.) onOffice-Anbietermandant:

Wir legen einen onOffice-Mandanten für Sie an, mit dem Sie sich mit der Software vertraut machen können. In diesem Anbietermandant sind alle Käufe gelistet, den die Kunden mit Ihrem Service getätigt haben.

Sie erhalten die Zugangsdaten per E-Mail zugeschickt. Ausführliche Informationen über onOffice enterprise finden Sie in der Onlinehilfe und im Bereich zum Marketplace. Prüfen Sie bitte, ob oben rechts in der Menüleiste „Sandbox“ zu sehen ist. Es ist nicht nötig, ein eigenes Marketplace-Konto in der Kontoverwaltung anzulegen, dies erledigen wir für Sie. Prüfen Sie, ob in der Kontoverwaltung schon ein Konto eingerichtet wurde. Ist dies nicht der Fall, kontaktieren Sie bitte Ihren Ansprechpartner aus dem Produktmanagement oder it-product-management@onoffice.de.

4.) Zahlungsabwicklung:

Die Zahlungsabwicklung für Ihre Services findet über den Zahlungsanbieter Mangopay statt. Sie erhalten dort ein Konto, welches wir für Sie einrichten. Die Einnahmen aus den Käufen im Marketplace können dann über einen Pay-Out auf das eigene Konto übertragen werden.

5.) Datenaustausch per API:

Der Datenaustausch zwischen onOffice enterprise und Ihrem Service findet per API statt. Um unsere API zu verwenden, bietet es sich an, unser API-SDK in PHP zu benutzen. Auch die Anbindung in anderen Programmiersprachen ist möglich, dann müssen aber timestamp und HMAC selber generiert werden. Neben den allgemeinen Calls, um Daten zu lesen und schreiben, gibt es einige spezielle Marketplace-Calls. Aus Sicherheitsgründen muss bei jedem API-Call der Parameter „extendedClaim“ von Ihnen mitgeliefert werden. Weitere Informationen zum „extendedClaim“ finden Sie hier.

6.) Freischaltung implementieren:

Bevor Kunden Ihren Service nutzen können, müssen die Kunden ihn zuerst freischalten. Dabei werden Informationen und die API-Zugangsdaten des Kunden an Sie übertragen. Diese speichern Sie ab. Der untere Teil des Freischaltungs-Popup ist per iFrame eingebunden und durch Sie zu programmieren.

Programmieren Sie die Freischaltung zuerst und danach den eigentlichen Shop. Teilen Sie uns dann die URL für die Freischaltung möglichst frühzeitig mit. Dadurch ist sichergestellt, dass Sie Ihre Shop-Implementierung  direkt testen können.

Am Einfachsten ist es, wenn sie unseren schon vorhandenen Programmcode dafür verwenden, und ggfs. individuell anpassen. Sie können die Quelldateien für den Freischaltungsprozess dafür benutzen, mit denen Sie die API-Benutzerdaten erhalten. In den Quelldateien für den Freischaltungsprozess wird der API-Call Anbieter freischalten mit den übergebenen Daten (parameterCacheId) aufgerufen, um Ihren Anbieter für den Kunden im Marketplace freizuschalten.

7.) Demo-Shop einbinden:

Im nächsten Schritt  stellen Sie Ihre Services im Marketplace zur Verfügung. Wir stellen dazu schon Code für einen Demo-Service zur Verfügung, den Sie für die Anbindung und zum Testen nutzen können. Mit dem Demoshop haben schon Sie die Möglichkeit, Zahlungen und Käufe innerhalb des Services zu tätigen und zu testen. Benutzen Sie dazu Demo-Shopwebseite in PHP als Vorlage für Ihren Shop. Dann sollte Ihr Demo-Service schon unter Marketplace >> Übersicht sichtbar sein.

8.) Service programmieren und einbinden:

Als nächstes programmieren Sie Ihren eigenen Service und ersetzen den Demo-Shop durch Ihren Service. Die Grundlagen aus unserer Demo-Shop-Implementierung können genutzt werden. Ist Ihr Service fertiggestellt, geben Sie unserem Produkmanagement Bescheid. Ihr Service wird dann durch unsere Testabteilung geprüft und wird danach für das Production-System für die Kunden freigegeben und kann genutzt werden. Vorher findet alles in einer Sandbox-Umgebung statt, in der man testen und Käufe simulieren kann. Dazu wird mit Testkreditkarten gearbeitet, dessen Nummern Sie bei Mangopay finden können. Eine Zahlungsart sollte schon eingetragen sein, und weitere Zahlungsarten tragen Sie im Marketplace-Konto ein.

9.) FAQ / Hinweise:

1.) API-Key (Secret) des Marketplace-API-Benutzers vs. Anbietersecret : Bitte verwechseln Sie nicht die beiden verschiedenen Secrets, die verwendet werden. Das Secret, auch API-Key genannt, Ihres API-Benutzers ist hier erklärt. Das Anbietersecret wird bei der Signatur benötigt und ist hier näher erläutert.

2.) Keinen eigenen API-Benutzer anlegen in Kundenversionen: Sie müssen keine eigenen API-Benutzer in den Kundenversionen von onOffice enterprise anlegen. Im Marketplace werden die API-Benutzer, über die Ihr Service mit onOffice enterprise Daten austauscht, automatisch beim Freischalten Ihres Services  angelegt. Um Daten aus Ihrem Anbietermandanten abzufragen, ist allerdings das Anlegen eines API-Benutzers nötig. (Siehe Punkt 3.)

3.) Um Ihren Service selber testen zu können, haben wir Ihnen einen eigenen Anbietermandant anlegt. In diesem Anbietermandant sind auch alle Käufe gelistet, den die Kunden mit Ihrem Service getätigt haben. Man kann dort die Funktionen „Nachzahlungslink generieren“ und „Transaktion stornieren“ manuell über die GUI durchführen. Diese beiden Funktionen können auch über die API im Anbietermandanten ausgeführt werden mit den API-Calls Nachzahlungslink generieren und Transaktion stornieren.  Falls Sie die Funktionen „Nachzahlungslink generieren“ und „Transaktion stornieren“ automatisiert über die API verwenden wollen, fragen Sie Ihren Ansprechpartner im onOffice Produktmanagement / der benötigte API-Benutzer wird dann eingerichtet.

4.) Eindeutige Identifikation eines Kunden: Ein Kunde kann nur eindeutig identifiziert werden über die Kombination von Mandanten-ID (customerWebId) und Benutzer-ID (userId). Ein Mandant ist eine Instanz der onOffice-Software, die viele Benutzer haben kann. Oft sind Mandanten Maklerbüros und Benutzer die Makler. Die Benutzer-ID alleine reicht nicht aus.

10.) Support und Hilfe:

– Informieren Sie sich hier in unserer technischen Dokumentation über die weiteren Möglichkeiten, die Sie mit dem Marketplace haben.
– Bei technischen Fragen wenden Sie sich gerne an unseren Marketplace-Support unter marketplace-dev@onoffice.de.
– Sie finden in der Onlinehilfe für die Marketplace-Kunden Informationen, wie der Marketplace funktioniert und welche anderen Anbieter es schon gibt.
– Die API-Dokumentation beschreibt, welche Möglichkeiten zum Datenaustausch mit Ihrem Service bestehen / welche Daten aus enterprise abgefragt und geschrieben werden können.
– Die Seite Buchhaltung verlinkt und fasst alle für die Buchhaltung und finanzielle Abwicklungen relevanten Themen zusammen. Die restlichen Themen in der Dokumentation sind eher für Entwickler relevant.