apimo™

Webservice & API

Bienvenue dans notre API dédiée aux prestataires immobiliers, vous y trouverez tous les détails d'une agence immobilière avec ses annonces, ses contacts et certains de ses paramètres. En fonction de vos droits, vous pouvez également envoyer des informations telles que des leads.

Partenaires

Demandez un essai gratuit

Contactez-nous

Caractéristiques

Bienvenue dans notre API dédiée aux prestataires immobiliers, vous y trouverez tous les détails d'une agence immobilière avec ses annonces, ses contacts et certains de ses paramètres. En fonction de vos droits, vous pouvez également envoyer des informations telles que des leads.

L'API d'Apimo fonctionne avec le format JSON
Protocole Nous donnons un certificat valide et signé pour toutes les méthodes de l'API. Assurez-vous que vos bibliothèques de connexion prennent en charge le protocol HTTPS.
Token Pour utiliser cette API, vous avez besoin d'un identifiant numérique et d'un Token. (request a token)
Limite Quota gratuit de 1 000 requêtes quotidiennes et de 10 requêtes/seconde (les quotas sont actualisés tous les jours dès minuit, heure de Paris/CEST).
Charset UTF-8
Content application/json
Langages fr (français) , it (italien) , de (allemand) , es (espagnol) , en (anglais) , nl (néerlandais) , zh (chinois) , ru (russe) , sv (suédois) , ar (arabe) , he (hébreu) , nb (norvégien bokmål) , pt (portugais) , fa (persan) , lb (luxembourgeois) , km (khmer) , tr (turc) , lo (lao)
L'API d'Apimo intègre 4 méthodes HTTP pour interagir avec les ressources
GET Utilisez une requête GET pour récupérer des données. Les requêtes GET ne provoqueront jamais de mise à jour ou de modification de vos données.
POST Utilisez une requête POST pour créer une ressource.
PUT Utilisez une requête PUT pour mettre à jour une ressource.
DELETE Utilisez une requête DELETE pour supprimer une ressource (soyez prudent!).

Webservices

Catalogs

Méthode HTTP Chemin Fonction
get /catalogs Get a list of catalogs
get /catalogs/{catalogs_id} Get a specific catalog

Agencies

Méthode HTTP Chemin Fonction
get /agencies Retrieve the business units list

Agencies/actions

Méthode HTTP Chemin Fonction
post /agencies/actions/{agency_id}/actions Create a new action
put /agencies/actions/{agency_id}/actions/{action_id} Update an action

Agencies/contacts

Méthode HTTP Chemin Fonction
get /agencies/contacts/{agency_id}/contacts Retrieve the contacts list
post /agencies/contacts/{agency_id}/contacts Create a new contact
put /agencies/contacts/{agency_id}/contacts/{contact_id} Update a contact

Agencies/contracts

Méthode HTTP Chemin Fonction
get /agencies/contracts/{agency_id}/contracts Retrieve the contracts list

Agencies/leads

Méthode HTTP Chemin Fonction
get /agencies/leads/{agency_id}/leads Retrieve the leads list
post /agencies/leads/{agency_id}/leads Create a new lead

Agencies/properties

Méthode HTTP Chemin Fonction
get /agencies/properties/{agency_id}/properties Retrieve the properties list
post /agencies/properties/{agency_id}/properties Create a new property
post /agencies/properties/{agency_id}/properties/{property_id}/medias Add/embed a media (virtual tour, video …)
delete /agencies/properties/{agency_id}/properties/{property_id}/media/{media_id} Delete a media (virtual tour, video …)
post /agencies/properties/{agency_id}/properties/{property_id}/pictures Update a picture
delete /agencies/properties/{agency_id}/properties/{property_id}/pictures/{picture_id} Delete a picture inside a property
get /agencies/properties/{agency_id}/properties/{property_id}/providers Provider list for a specific property
post /agencies/properties/{agency_id}/properties/{property_id}/providers Grant property access to a provider

Agencies/requests

Méthode HTTP Chemin Fonction
get /agencies/requests/{agency_id}/requests Retrieve the requests list

Agencies/residences

Méthode HTTP Chemin Fonction
get /agencies/residences/{agency_id}/residences Retrieve the residences list

Agencies/users

Méthode HTTP Chemin Fonction
get /agencies/users/{agency_id}/users Retrieve the users list
get /agencies/users/{agency_id}/users/{user_id}/actions Retrieve actions list of a specific user