ExApp¶

Resumen¶

Esta página describe las API OCS para acciones de las ExApps: obtener la lista de ExApps, establecer el progreso de inicialización, obtener la URL de APS Conecta Gestión, hacer solicitudes a las ExApps y obtener su estado de habilitación. Está dirigida a quienes desarrollan ExApps.

Fuente: documentación de Nextcloud, «developer_manual/exapp_development/tech_details/api/exapp», versión 3ad9158, licencia CC BY 3.0; traducida y adaptada para APS Conecta Gestión.

API OCS para acciones de las ExApps.

Obtener la lista de ExApps¶

Obtener la lista de ExApps instaladas.

Endpoint OCS: GET /apps/app_api/api/v1/ex-app/{list}

Hay dos opciones para list:

enabled: lista solo las ExApps habilitadas
all: lista todas las ExApps

Datos de la respuesta¶

Los datos de la respuesta son un array JSON de objetos ExApp con los siguientes atributos:

{
    "id": "appid of the ExApp",
    "name": "name of the ExApp",
    "version": "version of the ExApp",
    "enabled": "true/false flag",
    "last_check_time": "timestamp of last successful Nextcloud->ExApp connection check",
}

Establecer el progreso de inicialización de la ExApp¶

Se usa durante el paso de inicialización de la ExApp.

Nota

Requiere AppAPIAuth.

Endpoint OCS: PUT /apps/app_api/ex-app/status

Datos de la solicitud¶

{
    "progress": "progress value",
    "error": "optional, error string message"
}

Datos de la respuesta¶

Devuelve HTTP 200 si tiene éxito y HTTP 404 si hay un error.

Obtener la URL de APS Conecta Gestión¶

Puede que la ExApp necesite conocer (o actualizar) la URL de APS Conecta Gestión.

Endpoint OCS: GET /apps/app_api/api/v1/info/nextcloud_url

Datos de la respuesta¶

Devuelve la URL base de la instancia de APS Conecta Gestión:

{
    "base_url": "http(s)://nextcloud.example.com"
}

Hacer solicitudes a las ExApps¶

Hay dos endpoints para hacer solicitudes a las ExApps:

Solicitud síncrona: POST /apps/app_api/api/v1/ex-app/request/{appid}
Solicitud síncrona con el usuario establecido para la ExApp: POST /apps/app_api/api/v1/ex-app/request/{appid}/{userId}

Datos de la solicitud¶

Los parámetros de los datos de la solicitud son los mismos que en lib/PublicFunction.php:

{
    "route": "relative route to ExApp API endpoint",
    "method": "GET/POST/PUT/DELETE",
    "params": {},
    "options": {},
}

Nota

userId y appId se toman de los parámetros de la URL

Datos de la respuesta¶

La estructura de los datos de la respuesta OCS de una solicitud correcta a la ExApp es la siguiente:

{
    "status_code": "HTTP status code",
    "body": "response data from ExApp",
    "headers": "response headers from ExApp",
}

Si hay un error, el objeto de respuesta solo tendrá un atributo error con el mensaje de error.

Obtener el estado de habilitación de la ExApp¶

Devolver el estado de habilitación de la ExApp autenticada.

Endpoint OCS: GET /apps/app_api/api/v1/ex-app/state

Nota

La ExApp puede llamar a este endpoint aunque esté deshabilitada en el lado de APS Conecta Gestión, y requiere AppAPIAuth.

Datos de la respuesta¶

Devuelve 1 si la ExApp está habilitada y 0 si está deshabilitada.