La referencia de la API se publica en inglés.
Invoke a plugin action (URL-keyed bridge)
POST
/api/plugins/{pluginId}/actions/{key}Personal API keyConsole session
Invoke a plugin action (URL-keyed bridge).
Autorización
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Cómo funcionan las claves.
Parámetros de ruta
pluginIdstringObligatorioThe plugin's id.
keystringObligatorioThe action's key.
Cuerpo de la solicitud
application/json · obligatorio
companyIdstringOpcional
paramsobjectOpcional
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.