L’essentiel
Ce que l’API sait faire
- Le parc : équipements (avec toutes leurs données techniques, lues et corrigées), immeubles, clients, contacts.
- Les relevés : ceux d’un équipement, les données d’un relevé par composant (avec leur nom V1), ses photos (lues, déposées, rangées), ses documents PDF, et la création d’un relevé.
- Les étages d’un équipement, créés d’après son nombre de niveaux.
- Le commerce : affaires (création avec leurs relevés, statistiques), contrats et leurs variations de prix, devis, factures.
- La maintenance : appels en cours, ouverture et affectation d’un appel, visites dues, planning, techniciens, demandes de pièce.
- Les écarts et réserves, les notes, la recherche globale.
- L’import d’un tableau
.csvou.xlsx, vérifié avant d’écrire, tout ou rien. - Les webhooks : Arquos prévient votre logiciel quand un appel est clos, un relevé soumis, un devis accepté (voir Webhooks).
Les listes
Une liste se lit par pages :?limit=50&page=1 (200 au plus par page). Elle rend son total, la page, la limit et les results. Les listes du parc se cherchent avec ?q= ; les écarts, contrats, devis et factures se filtrent par statut, equipement ou client, et par dates de création (depuis, jusqua, au format AAAA-MM-JJ).
Les liens
Chaque objet rendu porte sonlink (le chemin de sa fiche) et son url complète : votre logiciel peut ouvrir la fiche dans Arquos d’un clic. C’est ce que faisaient open_myarquos et generate_token en V1.
Les écritures
Une écriture (création, correction) rend201 ou 200 avec l’identifiant et le lien de l’objet. Un refus rend 422 et sa raison en français ; un objet hors de vos agences, 404. Rien n’est écrit à moitié : une correction de plusieurs données techniques passe en entier ou pas du tout, comme un import.