API Agents

Cas d’usage de l’API

Exemples concrets avec les endpoints réels. Remplacez $LC_API_KEY par une clé créée dans Réglages → API Agents (plan Pilote).

1. 01

   Tour des impayés le matin

   Avant le café, un script (ou n8n) liste les échéances encore en attente / en retard pour préparer les relances.

   Gestionnaire · automatisation quotidienne · scopes payments:read

   1. Appeler GET /api/v1/payments avec un filtre status
   2. Parcourir la page suivante via next_cursor si besoin
   3. Afficher bail_id, montant et due_date dans Slack / e-mail / tableur

   curl — paiements en attente

   curl -sS -H "Authorization: Bearer $LC_API_KEY" \
     "https://locataire.live/api/v1/payments?status=en_attente&limit=50"

2. 02

   Ouvrir un incident depuis l’extérieur

   Un formulaire Typeform, un bot Telegram ou un artisan envoie le signalement : l’incident apparaît dans le dashboard, même parc.

   Terrain · outil tiers · scopes incidents:writeproperties:read

   1. Retrouver le property_id (liste biens ou fiche connue)
   2. POST /api/v1/incidents avec titre + description
   3. Suivre le dossier dans Sinistres comme d’habitude

   curl — créer un incident

   curl -sS -X POST \
     -H "Authorization: Bearer $LC_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "property_id": "550e8400-e29b-41d4-a716-446655440000",
       "title": "Fuite sous évier cuisine",
       "type": "degat_eaux",
       "description": "Signalé par le locataire via bot"
     }' \
     "https://locataire.live/api/v1/incidents"

3. 03

   Pointer un loyer reçu

   Après rapprochement bancaire maison (CSV, Power Automate), marquer l’échéance payée sans ouvrir le dashboard.

   Compta / script de rapprochement · scopes payments:writepayments:read

   1. Identifier l’id d’échéance via GET /api/v1/payments?lease_id=…
   2. POST /api/v1/payments/{id}/mark-paid
   3. La reconciliation comptable suit le même cœur métier que le bouton « Payé »

   curl — marquer payé

   curl -sS -X POST \
     -H "Authorization: Bearer $LC_API_KEY" \
     "https://locataire.live/api/v1/payments/7c9e6679-7425-40de-944b-e07fc1f90ae7/mark-paid"

4. 04

   Demander à un agent IA le détail d’un bail

   Dans Cursor ou Claude : « Qui sont les locataires du bail X ? » — l’agent appelle l’outil MCP get_lease.

   Bailleur / équipe · assistant IA · scopes leases:read

   1. Configurer l’agent sur POST /api/v1/mcp avec la clé Bearer
   2. tools/list → get_lease
   3. tools/call avec l’UUID du bail → locataires inclus dans la réponse

   MCP — tools/call get_lease

   curl -sS -H "Authorization: Bearer $LC_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "get_lease",
         "arguments": { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }
       }
     }' \
     "https://locataire.live/api/v1/mcp"

5. 05

   Exporter le parc pour un tableur / BI

   Chaque lundi, un cron tire la liste des biens (adresse, type, surface) vers Google Sheets ou un warehouse.

   Pilotage patrimoine · script hebdo · scopes properties:read

   1. Boucler GET /api/v1/properties avec cursor jusqu’à next_cursor null
   2. Écrire les lignes dans Sheets / BigQuery / Excel
   3. Révoquer la clé si le script change de machine

   curl — première page de biens

   curl -sS -H "Authorization: Bearer $LC_API_KEY" \
     "https://locataire.live/api/v1/properties?limit=100"

6. 06

   Annuaire locataires pour un mailing ciblé

   Préparer une liste e-mail (hors produit) : lecture seule des locataires, sans exposer les paiements.

   Communication · clé scoped minimale · scopes tenants:read

   1. Créer une clé avec uniquement tenants:read
   2. GET /api/v1/tenants (pagination cursor)
   3. Filtrer côté script (e-mail présent, etc.)

   curl — locataires

   curl -sS -H "Authorization: Bearer $LC_API_KEY" \
     "https://locataire.live/api/v1/tenants?limit=50"