La referencia de la API se publica en inglés.
Read the cheap host-local authentication signal for an adapter type
GET
/api/companies/{companyId}/adapters/{type}/auth-signalPersonal API keyAgent API keyConsole session
Read the cheap host-local authentication signal for an adapter type.
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.
typestringObligatorioThe type's id.
Parámetros de consulta
environmentIdstringOpcional
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.