Webservice & API

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: Sat, 21 Dec 2024 13:34:47 +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"}]

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' <?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);
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Exemple de réponse

HTTP/1.1 200 OK
Server: nginx
Date: Sat, 21 Dec 2024 13:34:47 +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"}]