La referencia de la API se publica en inglés.

Install an official plugin for an organization

POST/api/companies/{companyId}/plugins/{key}/install
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 2 · Historial

Install an official plugin for an organization.

Downloads and loads the verified bundle on the instance the first time any organization installs it, then turns the plugin on for this organization. Needs organization:manage_settings.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.
keystringObligatorioThe plugin's key.

Respuestas

200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Plugins