Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Cuerpo

application/json

Una clave de API nueva: su nombre, sus alcances y cuándo vence.

name
string
requerido

Un nombre que distinga la clave de las demás, como la integración que la usa.

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

Los alcances que recibe la clave, al menos uno, como inventory:read. Envía * para todos los alcances. La clave nunca puede hacer más que los permisos del miembro al que pertenece.

Minimum array length: 1

Lo que puede hacer una clave de API: leer o escribir un módulo, o todo. Una clave nunca puede hacer más de lo que permiten los permisos de su propietario.

Opciones 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

El último día en que funciona la clave, como YYYY-MM-DD, hoy o después. La clave deja de funcionar al terminar ese día, en UTC. Omítelo para una clave que no vence.

Respuesta

IssuedApiKeyResource

data
IssuedApiKeyResource · object
requerido

Una clave de API nueva y su token. El token se muestra solo esta vez.