REST-API: Länderprofile
Der Kern der API ist für jedes Land derselbe. Was je Land abweicht, steht in einem Profil. Deutschland ist das erste.
Zuletzt aktualisiert:
Die API hat einen Kern und ein Profil je Land. Der Kern ist überall derselbe: die Form eines Inserats, die Ids, die Fehler, das Blättern. Ein Länderprofil ergänzt, was das Recht oder der Markt dieses Landes braucht. Im Kern kommt kein Land vor.
Ein Profil trägt vier Dinge:
| Teil | Deutschland (de) |
|---|---|
| Standardwährung | EUR |
| Einheit der Flächen | SQUARE_METER |
| Angaben, die ein Inserat zur Veröffentlichung braucht | der Energieausweis oder die Aussage, dass keiner vorliegt oder nötig ist |
Der Abschnitt countrySpecific, den es besitzt | de, mit den Energieausweisen unter data.energy.countrySpecific.de |
Deutschland ist heute das einzige Profil. Weitere Länder kommen als weitere Profile, der Kern ändert sich dafür nicht. GET /v1/me nennt die Profile deines Büros unter profiles.
Ein Beispiel: der Energieausweis
Ein deutsches Wohninserat nennt seinen Energieausweis in data.energy.countrySpecific.de.energyCertificates. Das ist das Mitglied energy eines Inserats:
{
"countrySpecific": {
"de": {
"energyCertificates": [
{
"certificateType": "ENEV2014",
"certificateBasedOn": "CONSUMPTION",
"efficiencyClass": "C",
"validUntil": "2031-05-31",
"yearOfConstructionBuilding": 1998,
"primaryEnergySource": "GAS"
}
]
}
}
}Ein Entwurf darf ihn weglassen. Ein Inserat ohne ihn und ohne die Aussage NOT_AVAILABLE, NOT_NECESSARY oder AT_VISIT als certificateType lässt sich nicht veröffentlichen.
Was ein Profil bestimmt
- Währung und Einheit.
data.prices.currencyhat als Vorgabe die Währung des Profils, unddata.spaces.spaceMeasureUnitist die Einheit des Profils. Beides sind Mitglieder des Standards, wer sie ausdrücklich schickt, hängt also nie vom Profil ab. - Pflichtangaben. Was ein veröffentlichtes Inserat nennen muss, ist eine Regel des Profils. Ein Entwurf wird davon nie aufgehalten.
- Zusätzliche Daten. Der Standard hält seine Abschnitte
countrySpecificfür Mitglieder, die er nicht definiert, geschlossen. Athaus schickt die deutschen Zusätze inuserDefinedmit dem Präfixde.:
| Name | Inhalt |
|---|---|
de.livingSpaceStandard | die Berechnungsgrundlage der Wohnfläche: WOFLV, DIN_277 oder UNKNOWN |
de.usableSpaceStandard | dasselbe für die Nutzfläche |
de.siteCoverageRatio | der Anteil des Grundstücks, der überbaut werden darf |
de.floorAreaRatio | die Geschossfläche je Grundstücksfläche |
de.developmentState | der Entwicklungszustand eines Grundstücks, zum Beispiel BUILDING_READY |
Ein Land ohne Profil
Eine Anfrage mit einem Abschnitt countrySpecific für ein Land, das kein Profil hat, wird mit 400 und dem Code profile_unsupported beantwortet. Es wird nichts geschrieben. Lass den Abschnitt weg oder frag nach dem Land.
Eine Anfrage trägt die deutsche Angabe zum Wohnberechtigungsschein in seeker.countrySpecific.de.hasSubsidizedHousingCertificate, auf dieselbe Weise.
Weiter lesen
REST-API: Inserate in der Form von OpenImmo 2.0
Inserate lesen und schreiben in der Form von OpenImmo 2.0. Zwei Ids, Entwürfe, Quittungen, Hinweise und jedes Mitglied eines Inserats.
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
Fehlercodes der API: was jeder Code bedeutet
Jeder Code, den die REST-API im Mitglied code eines Problems liefert, mit HTTP-Status und Bedeutung. Aus dem Vertrag erzeugt.
Projekte
Neubauprojekte in der Form von OpenImmo 2.0 lesen und schreiben. Zwei Ids, das Recht `projects`, Quittungen und die Mitglieder, die von uns sind.
Blättern
Jede Liste von /v1 liefert eine Seite und einen Weg zur nächsten. Inserate nutzen ein Page Token, die übrigen Ressourcen einen Cursor. Keine Gesamtzahl.