Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Corps

application/json

Une nouvelle clé d'API : son nom, ses portées et sa date d'expiration.

name
string
requis

Un nom qui distingue la clé des autres, comme l'intégration qui l'utilise.

Maximum string length: 255
abilities
enum<string>[]
requis

Les portées que la clé obtient, au moins une, comme inventory:read. Envoyez * pour toutes les portées. La clé ne fait jamais plus que les autorisations du membre auquel elle appartient.

Minimum array length: 1

Ce qu'une clé d'API peut faire : lire ou écrire un module, ou tout. Une clé ne fait jamais plus que ce que les autorisations de son propriétaire permettent.

Options disponibles:
*,
access:read,
access:write,
audit:read,
address:read,
address:write,
billing:read,
billing:write,
catalog:read,
catalog:write,
dashboard:read,
dashboard:write,
developer:read,
developer:write,
devices:read,
devices:write,
documents:read,
documents:write,
notifications:read,
notifications:write,
inventory:read,
inventory:write,
purchasing:read,
purchasing:write,
quality:read,
quality:write,
sales:read,
sales:write,
engineering:read,
engineering:write,
manufacturing:read,
manufacturing:write,
automation:read,
automation:write,
insights:read,
insights:write,
integrations:read,
integrations:write,
labels:read,
labels:write,
library:read,
organization:read,
organization:write,
planning:read,
planning:write,
sync:read,
sync:write
expires_on
string<date> | null

Le dernier jour où la clé fonctionne, sous forme YYYY-MM-DD, aujourd'hui ou plus tard. La clé cesse de fonctionner à la fin de ce jour, en UTC. Omettez-le pour une clé qui n'expire pas.

Réponse

IssuedApiKeyResource

data
IssuedApiKeyResource · object
requis

Une nouvelle clé d'API et son jeton. Le jeton n'est affiché qu'une seule fois.