Présentation générale de l'API

Fonctionnalités

L’API d’Ublo permet de mettre en place des échanges de données en temps réel avec n’importe quel système capable de s’interfacer avec elle, aussi bien en lecture qu'en écriture.
Ouverte et utilisant une technologie moderne (GraphQL), elle permet d’uniformiser et de standardiser les échanges de données sur les domaines fonctionnels qu’elle couvre.

L'API couvre les fonctionnalités de la plateforme et permet de manière non-exhaustive :

• de lire, modifier, ou supprimer des réglages (organisations, collaborateurs, structure du patrimoine, plan comptable...)
• de consulter, créer ou modifier le référenciel patrimoine (groupes, types et modèle de lot, lot...)
• d'importer, mettre à jour ou consulter des éléments des répertoires (profils de personnes physiques ou morales, fournisseurs...)
• de récupérer, d'ajouter ou de modifier des éléments de facturation (facture, avoir, ligne d'opération...)
• de lire, créer et éditer les dossiers de locations
• ...

Prérequis

Cette documentation s’adresse à des développeurs ; les compétences suivantes sont requises :

• Compréhension du protocole HTTP (requêtes, headers, codes de statut)
• Manipulation de données structurées (JSON)
• Gestion de l’authentification (cookies, tokens, headers)
• Utilisation d’un client API (Postman, curl, Insomnia) ou
• Compétences en développement logiciel
• Connaissance des principes de protection des données personnelles (RGPD) et des bonnes pratiques de sécurisation des données sensibles (confidentialité, stockage sécurisé, chiffrement, contrôle d’accès)

Qu'est-ce que l'API GraphQL ?

L'API GraphQL vous permet d'accéder aux données et aux opérations Ublo via un seul endpoint.
Vous demandez exactement les champs dont vous avez besoin — ni plus, ni moins — ce qui simplifie l'intégration et évite le sur-fetch habituel avec REST.
Elle est conçue pour les applications tierces et les outils internes qui ont besoin d'accéder aux données de manière structurée.

En quoi c'est différent de REST ?

Avec REST, chaque ressource a sa propre URL et les réponses sont souvent « toutes faites ». Avec GraphQL, une seule URL sert pour tout : vous envoyez une requête qui décrit la forme des données souhaitées, et la réponse suit exactement cette structure.

Exemple : récupérer quelques champs d'un bien (query unit de l'API) :

query {
  unit(id: "00000000-0000-0000-0000-000000000000") {
    id
    customReference
    createdDate
  }
}

La section suivante détaille l'endpoint, l'authentification et les versions.