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

Catalogs

Retrieve all the words and translations of the API.

Méthodes disponibles

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

get Get a list of catalogs /catalogs

Paramètres du chemin

  • Aucun

Paramètres du contenu de la demande

  • Aucun

Contenu de la réponse

  •   Array
    • name  Name of the catalog
    • path  Absolute URL of the catalog

Exemple de requête

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/catalogs' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/catalogs');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Exemple de réponse

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 19 Dec 2018 06:54:38 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

[{"name":"property_activity","path":"https:\/\/api.apimo.pro\/catalogs\/property_activity"},{"name":"property_areas","path":"https:\/\/api.apimo.pro\/catalogs\/property_areas"}]

get Get a specific catalog /catalogs/{catalogs_id}

Paramètres du chemin

  • referential_id  The unique id for the catalog

Paramètres du contenu de la demande

  • culture  The language of the catalog

Contenu de la réponse

  •   Array
    • id  ID of the entry
    • culture  Language of the entry
    • name  Name of the entry
    • name_plurial  Plurial name of the entry (only for some catalogs)

Exemple de requête

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/catalogs/property_heating_type' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "culture": "en_GB" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/catalogs/property_heating_type');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "culture": "en_GB" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Exemple de réponse

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 19 Dec 2018 06:54:38 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

[{"id":1,"culture":"en_GB","name":"Gas"},{"id":2,"culture":"en_GB","name":"Fuel oil"},{"id":3,"culture":"en_GB","name":"Electric"},{"id":4,"culture":"en_GB","name":"Wood"}]