Référence de l’API
Adresse de base : https://api.sitigeo.com/v1. Description complète : openapi.json (OpenAPI 3.1), à importer dans Postman, Insomnia ou votre générateur de client.
GET/listings
Lister vos annonces.
| Paramètre | Où | Description |
|---|---|---|
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| status | requête | active | inactive | sold | removed |
| page | requête | integer |
| per_page | requête | integer |
| Réponse | Signification |
|---|---|
| 200 | Vos annonces et leur statut de publication |
POST/listings
Créer (ou mettre à jour) une annonce.
| Paramètre | Où | Description |
|---|---|---|
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| Champ du corps | Type | Description |
|---|---|---|
| reference * | string | Votre référence interne : clé d’idempotence (un même envoi ne crée jamais deux annonces) |
| type * | house | apartment | parking | garage | building | loft | warehouse | land | office | other | |
| title | string | |
| price * |
GET/listings/{ref}
Lire une annonce.
| Paramètre | Où | Description |
|---|---|---|
| ref * | chemin | Référence interne de l’annonce dans votre logiciel — string |
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| Réponse | Signification |
|---|---|
| 200 | L’annonce |
| 400 | Clé d’éditeur sans en-tête Sitigeo-Agence |
| 401 | Clé absente, inconnue, révoquée ou expirée |
PUT/listings/{ref}
Remplacer une annonce (la crée si la référence est inconnue).
| Paramètre | Où | Description |
|---|---|---|
| ref * | chemin | Référence interne de l’annonce dans votre logiciel — string |
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| Champ du corps | Type | Description |
|---|---|---|
| reference * | string | Votre référence interne : clé d’idempotence (un même envoi ne crée jamais deux annonces) |
| type * | house | apartment | parking | garage | building | loft | warehouse | land | office | other |
PATCH/listings/{ref}
Modifier quelques champs (prix, photos, statut…).
| Paramètre | Où | Description |
|---|---|---|
| ref * | chemin | Référence interne de l’annonce dans votre logiciel — string |
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| Réponse | Signification |
|---|---|
| 200 | Annonce publiée (201 à la création, 200 sinon ; 200 avec "test": true pour une clé de test) |
| 400 | Clé d’éditeur sans en-tête Sitigeo-Agence |
| 401 |
DELETE/listings/{ref}
Retirer une annonce (vendue, mandat expiré).
| Paramètre | Où | Description |
|---|---|---|
| ref * | chemin | Référence interne de l’annonce dans votre logiciel — string |
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| Réponse | Signification |
|---|---|
| 200 | Annonce retirée |
| 400 | Clé d’éditeur sans en-tête Sitigeo-Agence |
| 401 |
POST/sync
Envoyer le stock complet. Chaque annonce est créée ou mise à jour ; toute annonce en ligne absente de l’envoi est retirée. Un envoi vide est refusé sauf "allow_empty": true. 5 000 annonces au plus.
| Paramètre | Où | Description |
|---|---|---|
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| Champ du corps | Type | Description |
|---|---|---|
| listings * | liste de objet { reference, type, title, price, surface, rooms, new_build, exclusive, address, postal_code, city, description, dpe, ges, fees, photos, features, floor, year_built, property_tax, video_url, status } | |
| allow_empty | boolean |
GET/stats
Vues, contacts et mises en favori par annonce.
| Paramètre | Où | Description |
|---|---|---|
| Sitigeo-Agence | en-tête | Clé d’éditeur de logiciel seulement : SIREN de l’agence pour laquelle vous publiez (elle doit vous avoir autorisé) — string |
| Réponse | Signification |
|---|---|
| 200 | Statistiques |
| 400 | Clé d’éditeur sans en-tête Sitigeo-Agence |
| 401 | Clé absente, inconnue, révoquée ou expirée |
| 403 | Agence suspendue, pas encore validée (clé de production), ou n’ayant pas autorisé cet éditeur |
Les champs marqués * sont obligatoires.