API publique
API publique Blueputto pour un accès CRUD authentifié aux enregistrements de l’espace de travail, avec des endpoints versionnés, des clés API, la pagination, des filtres et des actions de workflow.
Grzegorz
L’API publique est la couche d’intégration authentifiée de Blueputto. Elle expose les mêmes enregistrements de base que l’application utilise au quotidien, ce qui permet aux systèmes externes de créer, lire, mettre à jour et supprimer des données opérationnelles sans introduire un second modèle de contenu à côté de l’interface utilisateur.
Cette API est disponible sous /v1 et est conçue pour fonctionner avec des clés API au niveau de l’organisation. C’est donc la fonctionnalité utilisée par les équipes lorsque les données Blueputto doivent être transférées vers un site web, une automatisation, un script d’importation, un tableau de bord interne ou un autre système produit.
Une API versionnée unique pour les principales ressources de l’espace de travail
Le point d’entrée /v1 renvoie une charge utile de découverte compacte avec la version de l’API, le format d’authentification, l’URL du document OpenAPI et la liste des ressources actuellement exposées.
Dans l’implémentation actuelle, la surface publique couvre :
documents,
éléments,
collections,
dossiers,
catégories,
statuts,
étiquettes,
et modèles de document.
La plupart de ces ressources prennent en charge le parcours opérationnel standard de listing, récupération, création, mise à jour et suppression. L’API expose également des actions spécifiques au workflow lorsque l’interface en a besoin, telles que :
restauration et suppression définitive pour les documents et les éléments,
duplication pour les documents,
réorganisation pour les catégories, les statuts et les étiquettes,
et filtrage des seuls actifs pour les modèles de document.
C’est ce qui fait de l’API publique bien plus qu’une simple couche d’exportation en lecture seule. Elle correspond étroitement au cycle de vie réel des enregistrements déjà visible dans Blueputto lui-même.
L’authentification et le format des réponses restent prévisibles
L’API publique accepte l’identifiant de l’organisation dans l’un de ces deux formats standard :
x-api-key,
ou Authorization: Bearer <key>.
Cela offre aux équipes de la flexibilité lorsqu’elles connectent Blueputto à différents environnements d’exécution, passerelles et styles de SDK. La clé elle-même est créée dans l’application depuis la page de paramètres API Keys.
Le format des réponses est également volontairement cohérent. Les réponses portant sur une seule ressource sont renvoyées dans une enveloppe data. Les endpoints de liste renvoient data avec meta, qui inclut des détails de pagination tels que page, limit, le nombre total d’éléments, le nombre total de pages et l’état de la page suivante ou précédente.
Sur l’ensemble actuel des ressources, l’API expose également des filtres pratiques qui reflètent les workflows réels de l’interface, notamment search, deletedOnly, folderId, withoutFolder et activeOnly.
Conçue autour des mêmes règles opérationnelles que l’application
L’aspect utile de l’API publique de Blueputto ne tient pas seulement au fait que les enregistrements sont accessibles de l’extérieur. Il tient au fait que la surface d’intégration suit les mêmes règles que celles que le produit applique déjà dans l’interface utilisateur.
Par exemple, la suppression de documents et d’éléments est modélisée comme un flux passant d’abord par la corbeille plutôt que par une destruction immédiate. Certaines opérations sur les documents peuvent renvoyer une réponse d’état verrouillé lorsque l’enregistrement n’est pas modifiable à ce moment-là. La limitation de débit est appliquée par clé API, avec une limite backend par défaut actuellement fixée à 5 req/s par clé.
Cela maintient l’API alignée sur le comportement réel de l’application. Les intégrations externes fonctionnent avec le véritable modèle de ressources de Blueputto, et non avec un canal secondaire simplifié qui se comporte différemment du produit.
