API referansı İngilizce yayımlanır.

Install an official plugin for an organization

POST/api/companies/{companyId}/plugins/{key}/install
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 2 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.
keystringZorunluThe plugin's key.

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Plugins