API & Webservice

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
Langues	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/{agency_id}/actions	Create a new action
put	/agencies/{agency_id}/actions/{action_id}	Update an action

Agencies/contacts

Méthode HTTP	Chemin	Fonction
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

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

Agencies/leads

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

Agencies/properties

Méthode HTTP	Chemin	Fonction
get	/agencies/{agency_id}/properties	Retrieve the properties list
post	/agencies/{agency_id}/properties	Create a new property
put	/agencies/{agency_id}/properties/{property_id}	Update a property
post	/agencies/{agency_id}/properties/{property_id}/medias	Add/embed a media (virtual tour, video …)
delete	/agencies/{agency_id}/properties/{property_id}/medias/{media_id}	Delete a media (virtual tour, video …)
post	/agencies/{agency_id}/properties/{property_id}/pictures	Update a picture
delete	/agencies/{agency_id}/properties/{property_id}/pictures/{picture_id}	Delete a picture inside a property
post	/agencies/{agency_id}/properties/{property_id}/documents	Add a document
delete	/agencies/{agency_id}/properties/{property_id}/documents/{document_id}	Delete a document inside a property
post	/agencies/{agency_id}/properties/{property_id}/comments	Add/Update a comment
get	/agencies/{agency_id}/properties/{property_id}/providers	Provider list for a specific property
post	/agencies/{agency_id}/properties/{property_id}/providers	Grant property access to a provider
PUT	/agencies/{agency_id}/properties/{property_id}/provider	Update information related to the publishing of the property
get	/agencies/{agency_id}/properties/{property_id}/crossings	Crossing list (matched requests) for a specific property

Agencies/requests

Méthode HTTP	Chemin	Fonction
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

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

Agencies/users

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

Webservice & API