Tomorro propose une API GraphQL publique vous permettant de recevoir et d'envoyer des données.
Les possibilités sont nombreuses et permettent concrètement de réaliser presque toutes les opérations possibles sur notre plateforme. C'est la même API que nous utilisons en interne pour développer nos applications et fournir des connexions à d'autres outils.
L'utilisation de l'API V1 (GraphQL) va être dépréciée. Si vous commencez une nouvelle intégration, utilisez l'API V2 (REST) :
Documentation développeurs
Notre documentation API : https://developers.tomorro.com/welcome
Queries → Toutes les possibilités pour extraire de la donnée de Tomorro vers des logiciels tiers.
Mutations → Toutes les possibilités pour envoyer de la données de logiciels tiers vers Tomorro.
Notre documentation webhook : Comment les utiliser ? / Documentation technique
Ce que couvre l'API V2 (REST)
L'API V2 permet notamment de :
Membres : lister tous les membres de votre organisation (GET /v2/members), consulter un membre (GET /v2/members/:id), en créer ou en modifier.
Tableaux personnalisés (custom objects) : lister vos tableaux (GET /v2/custom-objects), lire la structure et les colonnes d'un tableau (GET /v2/custom-objects/:id), ajouter ou mettre à jour les lignes d'un tableau sur un contrat (PUT /v2/custom-objects/:customObjectId/contract/:contractId/records).
Contrats : lister et lire les contrats, y compris les valeurs de leurs champs personnalisés (GET /v2/contracts, GET /v2/contracts/:id).
Champs personnalisés : lister les champs (GET /v2/smart-fields) et les options des champs de type liste (GET /v2/smart-fields/:id/options).
La lecture des lignes d'un tableau personnalisé n'est pas encore disponible via l'API (seule l'écriture l'est). La liste complète des endpoints et leurs schémas est disponible dans la documentation développeurs V2.
Glossaire
Nom API | Nom Tomorro |
type | Types de contrat |
template | Modèle |
contract | Contrat |
document | Document du contrat |
externalCompany | Cocontractant |
attributeDefinition | Champ personnalisé |
Authentification & Setup
Endpoint : https://api.tomorro.com/graphql
Content-Type : application/json
X-API-KEY : YourAPIKey
Une clé API personnelle peut être générée dans l'application Tomorro.
Aller sur
https://app.tomorro.com/integrationsPuis dans la section API > Générer une clé API
Tips
Vous pouvez récupérer les ids directement depuis l'URL (disponible pour les types de contrat, contrats, cocontractants…).
"GraphQL Network Inspector" peut vous aider à visualiser les requêtes que vous faites en live sur l'appli.
Télécharger l'extension
Pendant l'utilisation de Tomorro > Clic droit > Inspecter
Aller sur "GraphQL Network"
