OpenCage hat eine Anhängerschaft unter Entwicklern aufgebaut, die eine unkomplizierte, gut dokumentierte Geokodierungs-API ohne viel Beiwerk schätzen. Wir haben unseren Kompatibilitäts-Host im selben Geist gebaut: Anfrage- und Antwortformat exakt nachbilden, damit sich nichts am Wechsel wie ein Neuanfang anfühlt.
Der Host bildet die Anfrageparameter und den Antwortinhalt von OpenCage präzise nach, die einzigen Unterschiede sind die Texte zu Urheberrecht, Nutzungsbedingungen und Datenschutz, die von My Geocode stammen. Code, der derzeit eine Anfrage im OpenCage-Format erstellt und eine Antwort im OpenCage-Format auswertet, lässt sich auf unseren Host umstellen, ohne dass diese beiden Teile angefasst werden.
Was sich ändert, sind der Hostname in Ihrer Konfiguration und der Schlüssel, mit dem Sie sich authentifizieren. Dieser Schlüssel kann als X-API-Key-Header, als Authorization: Bearer-Header, per HTTP Basic Auth mit dem Schlüssel als Benutzernamen oder als Query-Parameter gesendet werden, passend zu dem Ansatz, den Ihre bestehende Client-Bibliothek bereits verfolgt. Alle vier funktionieren auf jedem Host, den wir betreiben, gleich.
Die Preise folgen unserer Standardstruktur, unabhängig davon, welcher Host eine Anfrage verarbeitet. Jede Adresse erhält 2.500 kostenlose Anfragen pro Tag ganz ohne Schlüssel, gezählt pro Netz. Ein Schlüssel fügt darüber hinaus eigene 2.500 kostenlose Anfragen pro Tag hinzu. Jenseits beider Kontingente kostet Prepaid-Guthaben 0,0001 € pro Anfrage, oder ein Unlimited-Paket deckt die Nutzung für 50 € im Monat ab, und nichts davon ändert sich, je nachdem, ob ein Aufruf über diesen Kompatibilitäts-Host oder direkt über /v1/forward lief.
Bei jeder Antwort werden Kontingent-Header mitgeliefert und bieten eine zusätzliche Transparenz bei der Nutzung, die eine einfache OpenCage-Integration sonst nicht hätte: X-Quota-Limit, X-Quota-Used, X-Quota-Free-Remaining, X-Quota-Network-Used, X-Credits-Remaining, X-Key-IPs-Used, X-Key-IPs-Limit und X-Quota-Reset sind jedes Mal enthalten.
Für Teams, die mehr möchten, als die kompatible Antwort standardmäßig liefert, fügt mg_extras=1 in der Anfrage oder ein X-MG-Extras-Header optionale Felder wie die Geländehöhe hinzu, ohne die Grundstruktur zu stören, sofern Sie das nicht verlangen.
Die Dokumentation zum Host finden Sie unter /compatibility/opencage/, und einen umfassenderen Überblick darüber, wie Kompatibilitäts-Hosts auf der gesamten Plattform funktionieren, unter /docs/compatibility/. Wenn OpenCage bereits in Ihren Stack eingebunden ist, braucht ein Test nur eine geänderte Basis-URL und einen neuen Schlüssel.