apimo™

Webservice & API

Welcome to our API dedicated to Real Estate providers, you will find all the details of a real estate agency with its products, contacts and settings. Depending on your rights you can also send some information such as leads.

Partners

Catalogs

Retrieve all the words and translations of the API.

Available methods

HTTP method Path Function
get /catalogs Get a list of catalogs
get /catalogs/{catalogs_id} Get a specific catalog

get Get a list of catalogs /catalogs

Path parameters

  • None

Request body parameters

  • None

Response body

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

Example request

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);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 23 May 2019 14:54:33 +0200
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}

Path parameters

  • referential_id  The unique id for the catalog

Request body parameters

  • culture  The language of the catalog

Response body

  •   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)

Example request

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);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 23 May 2019 14:54:33 +0200
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"}]