Spezifikationen
Willkommen in unserer API für Immobilienanbieter, hier finden Sie alle Details einer Immobilienagentur mit ihren Anzeigen, Kontaktiert und einigen ihrer Parameter. Je nach Ihren Rechten können Sie auch Informationen wie Leads versenden.
| Die API von apimo funktioniert im JSON Format | |
|---|---|
| Protokoll | Für alle API Methoden stellen wir ein gültiges und signiertes Zertifikat zur Verfügung. Stellen Sie sicher, dass Ihre Verbindunsbibliotheken das HTTPS-Protokoll unterstützen. |
| Token | Um diese API nutzen zu können, benötigen Sie einen numerischen Identifikator und ein Token. (request a token) |
| Grenzwert | Kostenlose Quote von 1.000 täglichen Anfragen und 10 Anfragen / Sekunde (die Quoten werden täglich ab Mitternacht (Paris/MESZ-Zeit) aktualisiert). |
| Charset | UTF-8 |
| Content | application/json |
| Sprachen | fr (Französisch) , it (Italienisch) , de (Deutsch) , es (Spanisch) , en (Englisch) , nl (Niederländisch) , zh (Chinesisch) , ru (Russisch) , sv (Schwedisch) , ar (Arabisch) , he (Hebräisch) , nb (Norwegisch Bokmål) , pt (Portugiesisch) , fa (Persisch) , lb (Luxemburgisch) , km (Khmer) , tr (Türkisch) , lo (Laotisch) |
| Die apimo-API integriert 4 HTTP-Methoden zur Interaktion mit den Ressourcen. | |
|---|---|
| GET | Verwenden Sie eine GET-Anfrage, um Daten wiederherzustellen. GET-Anfragen werden niemals dazu führen, dass Ihre Daten aktualisiert oder geändert werden. |
| POST | Verwenden Sie eine POST-Anfrage, um Ressourcen zu erstellen. |
| PUT | Verwenden Sie eine PUT-Anfrage, um Ressourcen zu aktualisieren. |
| DELETE | Verwenden Sie eine DELETE-Anfrage, um eine Ressource zu löschen (seien Sie vorsichtig mit der Verwendung!) |
Webservices
Catalogs
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /catalogs | Get a list of catalogs |
| get | /catalogs/{catalogs_id} | Get a specific catalog |
Agencies
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /agencies | Retrieve the business units list |
Agencies/actions
| HTTP Methode | Weg | Funktion |
|---|---|---|
| post | /agencies/{agency_id}/actions | Create a new action |
| put | /agencies/{agency_id}/actions/{action_id} | Update an action |
Agencies/contacts
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /agencies/{agency_id}/contacts | Retrieve the contacts list |
| post | /agencies/{agency_id}/contacts | Create a new contact |
| put | /agencies/{agency_id}/contacts/{contact_id} | Update a contact |
Agencies/contracts
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /agencies/{agency_id}/contracts | Retrieve the contracts list |
Agencies/leads
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /agencies/{agency_id}/leads | Retrieve the leads list |
| post | /agencies/{agency_id}/leads | Create a new lead |
Agencies/properties
Agencies/requests
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /agencies/{agency_id}/requests | Retrieve the requests list |
| post | /agencies/{agency_id}/requests | Create a new request |
| put | /agencies/{agency_id}/requests/{request_id} | Update a request |
| get | /agencies/{agency_id}/requests/{request_id}/crossings | Crossing list (matched properties) for a specific request |
Agencies/residences
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /agencies/{agency_id}/residences | Retrieve the residences list |
Agencies/users
| HTTP Methode | Weg | Funktion |
|---|---|---|
| get | /agencies/{agency_id}/users | Retrieve the users list |
| get | /agencies/{agency_id}/users/{user_id}/actions | Retrieve actions list of a specific user |