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

Agencies/contacts

Méthodes disponibles

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

get Retrieve the contacts list /agencies/{agency_id}/contacts

Paramètres du chemin

  • agency_id  The unique id for the real estate agency

Paramètres du contenu de la demande

  • limit  The number of records to return (max: 200, default: 100)
  • offset  The number of records to skip (default: 0)
  • timestamp  Return records created or updated since this UNIX/POSIX timestamp

Contenu de la réponse

  • total_items  The total number of item regardless of pagination
  • timestamp  UNIX/POSIX timestamp of the most recent item inside this list
  • contacts  Array

Exemple de requête

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/contacts' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/contacts');
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);
?>

post Create a new contact /agencies/{agency_id}/contacts

Paramètres du chemin

  • agency_id  The unique id for the real estate agency

Paramètres du contenu de la demande

Contenu de la réponse

  • id  Unique ID
  • created_at  Date/time of the first creation
  • updated_at  Date/time of the last update

Exemple de requête

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/contacts' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/contacts');
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, '{ }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Exemple de réponse

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 29 May 2020 08:23:08 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"3021944"}

put Update a contact /agencies/{agency_id}/contacts/{contact_id}

Paramètres du chemin

  • agency_id  The unique id for the real estate agency
  • contact_id  The unique id for the contact to update

Paramètres du contenu de la demande

Contenu de la réponse

  • id  Unique ID
  • created_at  Date/time of the first creation
  • updated_at  Date/time of the last update

Exemple de requête

Console
PHP
curl --request PUT \
--url 'https://api.apimo.pro/agencies/{agency_id}/contacts/{contact_id}' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/contacts/{contact_id}');
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, '{ }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Exemple de réponse

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 29 May 2020 08:23:08 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"3021944"}