Clients API
L'accès machine à cette plateforme est restreint et limité en débit. La clé n'est affichée qu'une seule fois lors de son émission.
Où le trouver
- Module: Plate-forme
- Groupe: Connectivité
- Section: API et événements
- Écran: Clients API
Adresse dans la console: /platform/api-clients
Liste · 9 colonnes · 8 champs sur son formulaire · 2 d'entre eux requis · 1 action
Ce que la liste affiche
Voici les colonnes de la liste, dans l'ordre où elles apparaissent. Chacune d'elles peut être triée, filtrée, masquée ou exportée.
| Colonne | Gentil | Nom du champ |
|---|---|---|
| Client | Code | code |
| Nom | Texte | name |
| Préfixe | Code | key_prefix |
| Clé | Code | key_last4 |
| Lunettes de visée | Texte | scopes |
| Taux/min | Nombre | rate_limit_per_minute |
| Appels | Nombre | call_count |
| Dernière utilisation | Date et heure | last_used_at |
| Statut | Statut | status |
Le formulaire
Voici les informations demandées lors de la création d'un enregistrement. Les champs obligatoires sont indiqués ; un choix issu d'une liste de configuration est un choix qu'un administrateur peut compléter sans nouvelle version.
| Champ | Taper | Choix | Notes |
|---|---|---|---|
| Code client requis | Texte | ||
| Nom requis | Texte | ||
| À quoi ça sert | Texte long | ||
| Lunettes de visée | Texte | Séparés par des virgules, par exemple : accounting:read, scm:read | |
| Limite de débit par minute | Nombre | ||
| Adresses IP autorisées | Texte | ||
| Statut | Choix | actif, suspendu, révoqué | |
| Expire | Date |
Ce que vous pouvez faire ici
Clé d'émission primaire
Émettre une nouvelle clé API
Les règles qui s'appliquent ici
Tout ce qui s'affiche à l'écran obéit aux règles de la plateforme et non à des règles propres. Voici celles qu'il est important de connaître avant de l'utiliser :
- Réduire une liste — Recherche, conditions, tri, totaux, exportation et vues enregistrées.
- Ce qui peut être changé — les cinq motifs pour lesquels un enregistrement ne peut être modifié.
- Entreprises et unités commerciales — ce que le commutateur situé au-dessus de cette liste lui fait.
- Création d'un enregistrement — champs obligatoires, provenance des choix et mode d'attribution des numéros.
- Importer une feuille de calcul — Cet écran en accepte un, et il suit les mêmes règles que la saisie au clavier.