Erste Schritte
In wenigen Schritten zur API-Integration. Wir freuen uns, dass Sie sich für unsere APIs interessieren. Um Ihnen die Integration möglichst einfach zu machen, finden Sie auf dieser Seite relevante Informationen zu den Voraussetzungen und dem Ablauf der Integration. Bitte lesen Sie die folgenden Punkte aufmerksam durch. Sollten noch Fragen offenbleiben, finden Sie weiter unten unsere Kontaktdaten.
Überblick über das Developer Studio
Mit dem Developer Studio wollen wir Ihnen einen Überblick über unsere aktuell verfügbaren APIs ermöglichen und Ihnen Hilfestellungen bei der Integration geben. Sie finden alle derzeit über dieses Studio veröffentlichten APIs im Menüpunkt APIs. Hier können Sie die einzelnen APIs selektieren und sich die implementierten Endpunkte und deren technischen Spezifikationen ansehen. Sie finden für jede API und jeden Endpunkt eine kurze Beschreibung und eine Angabe zum möglichen Anwendungsfall, für den diese API gedacht ist, sowie gegebenenfalls Einschränkungen oder weitere Hinweise. Zusätzlich zur Beschreibung können Sie sich auch eine YAML- oder JSON-Datei für die jeweilige Version des Endpunkts herunterladen.
Voraussetzungen für die Integration unserer APIs
Geschäftsverhältnis zur Prohyp Für die Nutzung der meisten APIs benötigen Sie einen Vermittler-Account in ehyp – unserer Baufinanzierungsplattform. Dieser beinhaltet neben Ihren Kontaktdaten auch diverse individuelle Einstellungen, auf die sich unsere APIs beziehen. Die Erstellung eines Accounts ist ganz einfach. Bitte nutzen Sie auf unserer Website www.prohyp.de die Funktion „Jetzt Partner werden“. Nach Eingabe Ihrer Kontaktdaten werden wir Ihren Account anlegen und Ihnen den Kooperationsvertrag zukommen lassen. Unsere Nutzungsbedingungen Für die Nutzung unserer APIs gelten bestimmte Voraussetzungen, deren aktuellste Version Sie in der Rubrik Nutzungsbedingungen finden. Bitte lesen Sie diese aufmerksam durch. Sollten Sie mit den Bedingungen nicht einverstanden sein, ist die Integration und Nutzung unserer APIs leider nicht möglich. Vor Freischaltung der APIs werden Ihnen die Nutzungsbedingungen nochmals zur Verfügung gestellt - mit der Bitte diese zu bestätigen. Bei Fragen wenden Sie sich gerne an am@prohyp.de.
Authentifizierung über Token
Die Authentifizierung für unsere APIs erfolgt mittels Token. Diesen Token können Sie über die Authorization API abrufen. Die für den Aufruf dieser API relevanten Daten erhalten Sie nach Anlage Ihres Accounts. Wir wollen Ihnen den Zugang zu unseren APIs möglichst einfach und einheitlich ermöglichen. Dennoch gibt es einige APIs, die aufgrund ihres Alters eine andere Methode der Authentifizierung benötigen. Die Information finden Sie in der jeweiligen API-Dokumentation.
Authentifizierung über API Keys
Für die Benutzung unserer APIs ist eine Authentifizierung aller Aufrufe mittels API Key notwendig. Daher muss Ihr individueller API Key als Header in jedem Aufruf an unsere APIs mit übertragen werden. Für die unterschiedlichen Systemlandschaften erhalten Sie jeweils einen gesonderten API Key. Ihre individuellen API Keys können Sie beim Ausstellen Ihrer Anmeldedaten für die Authorization API erfragen.
Grundsätzliches
Verfügbarkeit von veralteten APIs Manchmal sind neue Features oder Technologien so andersartig, dass Sie nicht in eine bestehende API integriert werden können. In diesem Fall werden wir eine neue Version der API bereitstellen. Um die neuen Features zu nutzen, müssen Sie auf die neue Version der API wechseln. Wir werden die alte Version für einen gewissen Zeitraum weiter betreiben, um Ihnen die Möglichkeit zur Planung des technischen Umbaus zu geben. APIs, die veraltet sind, werden in der API-Dokumentation als DEPRECATED markiert und zu einem bestimmten Zeitpunkt deaktiviert. Wir empfehlen diese APIs nicht mehr neu zu implementieren, sondern die aktuelle Version zu nutzen. Tolerant-Reader-Patterns Bestehende APIs werden stetig weiterentwickelt. Somit können weitere Daten ausgeliefert oder neue Endpunkte hinzugefügt werden. Unser Ziel ist es, neue Funktionalitäten ohne "Breaking Changes" an der API hinzuzufügen. Hierzu muss der Client das Tolerant-Reader-Pattern unterstützen. Dies bedeutet, unbekannte Felder dürfen nicht als Fehler angesehen werden, sondern müssen ignoriert werden.
Bei Fragen
Wenn im Zuge der Integration oder des Betriebs unserer APIs Fragen auftreten, die sich durch die API-Dokumentation und die bereitgestellten Beispieldateien, (z.B. Postman-Collections für beispielhafte API-Calls) nicht beantworten lassen, können Sie sich gerne an am@prohyp.de wenden.