Restreindre l'exposition de l'API

Couper ou rouvrir, pour toutes les clés à la fois, une entité du CRM ou la lecture des devis et des factures

À quoi ça sert

Les règles d'exposition de l'API s'appliquent à toutes les clés de l'organisation, au-dessus de leurs accès propres. Elles servent à couper une opération pour tout le monde d'un coup — par exemple interdire la création de fiches via l'API le temps d'une migration — sans modifier chaque clé une par une.

Une clé garde ses propres accès en mémoire : resserrer une règle les lui retire tout de suite, et l'assouplir ensuite les lui rend automatiquement, sans qu'il faille recréer la clé.

Concepts clés

Exposition de l'API — l'ensemble des règles qui plafonnent ce qu'une clé peut faire, quels que soient ses propres accès.
Entité masquée — une entité CRM dont la lecture est coupée pour toute l'organisation. Ses adresses répondent comme si elle n'existait pas, pour toutes les clés.
Opération coupée — la création ou la modification retirée pour toute l'organisation sur une entité CRM. L'appel concerné échoue.
Facturation ouverte ou fermée — la lecture des devis ou des factures, autorisée ou coupée pour toute l'organisation.

Comment faire

Ouvrir l'exposition de l'API

Sur la page « API publique », cliquez sur « Exposition de l'API », en haut de la liste des clés.

La page affiche, pour chaque entité CRM, les opérations actuellement ouvertes à l'ensemble des clés, avec le nombre de clés qui y ont accès ; et pour les devis et les factures, si la lecture est ouverte ou fermée.

Restreindre une entité CRM pour toutes les clés

Sur « Exposition de l'API », repérez l'entité CRM concernée.
Décochez l'opération à couper : « Lecture », « Création » ou « Modification ».
Si des clés actives perdent un accès, confirmez dans la fenêtre « Restreindre » qui s'ouvre : elle indique combien de clés sont concernées.

Décocher « Lecture » masque l'entité pour toutes les clés, y compris ses opérations de création et de modification.

Rouvrir une entité CRM

Sur « Exposition de l'API », cochez à nouveau l'opération voulue pour l'entité.

Les clés qui avaient déjà cette opération dans leurs propres accès la retrouvent immédiatement, sans autre action.

Couper ou rouvrir la lecture des devis ou des factures

Sur « Exposition de l'API », dans le bloc « Facturation », cliquez sur « Lecture » en face de « Devis » ou de « Factures ».
Confirmez si des clés actives perdent l'accès.

Les entités légales suivent : elles restent lisibles tant que les devis ou les factures le sont.

Référence

Effet d'une restriction

Opération retirée	Effet pour toutes les clés
Lecture d'une entité CRM	L'entité et ses fiches répondent comme inexistantes
Création ou modification d'une entité CRM	L'appel correspondant échoue
Lecture des devis ou des factures	Les appels de lecture sur cette ressource échouent

Ce qui limite une restriction

Une opération déjà coupée sur l'entité elle-même (« Autoriser la création » ou « Autoriser l'édition » décochée dans le CRM) ne peut pas être rouverte ici : l'exposition de l'API ne fait que retirer, jamais ajouter, un droit que l'entité elle-même n'accorde pas. Voir Entités du CRM.
Une entité du CRM réservée à certains rôles pour la lecture, la création ou la modification n'est ouverte à une clé que si celle-ci détient l'un de ces rôles, quelle que soit la règle posée ici. Voir Créer et gérer les clés API.
Pour les devis et les factures, la règle ne peut que fermer la lecture : ouverte, elle ne donne aucun accès à une clé qui ne l'a pas dans ses propres accès.
Une entité du CRM réservée à certains rôles pour la lecture, la création ou la modification n'est ouverte à une clé que si celle-ci détient l'un de ces rôles, quelle que soit la règle posée ici. Voir Créer et gérer les clés API.
Pour les devis et les factures, la règle ne peut que fermer la lecture : ouverte, elle ne donne aucun accès à une clé qui ne l'a pas dans ses propres accès.
Une entité inactive ou supprimée n'apparaît jamais dans l'exposition de l'API.