Saltar a contenido

Referencia de endpoints

Esta página se genera con tools/collect_api_endpoints.py a partir de los archivos de rutas del producto. No la edites a mano: vuelve a ejecutar el generador.

53 endpoints para integraciones.

La base es {host}/{espacio}/{idioma}/lurana/api. El espacio de trabajo viaja en el cuerpo de la petición, no en la ruta. Ver Conceptos de la API para la autenticación y el formato de las respuestas.

La API tiene más rutas: las que usan las pantallas de administración para llamarse a sí mismas. No son para integraciones y no se listan: 116 rutas quedan fuera de esta página.

Cada endpoint lleva el método, la ruta y la acción del controlador. Las páginas escritas explican los parámetros y el comportamiento.

Autenticación (7)

Método Ruta Acción
POST /auth/check-user LoginController@checkUser
POST /auth/login LoginController@login
POST /auth/update-timezone LoginController@updateTimezone
POST /auth/token/refresh TokenRefreshController@refresh
POST /auth/forgot-password PasswordRecoveryController@forgotPassword
POST /auth/validate-reset-token PasswordRecoveryController@validateToken
POST /auth/reset-password PasswordRecoveryController@resetPassword

Token OAuth (1)

Método Ruta Acción
POST /oauth/token —

Casos (27)

Método Ruta Acción
POST /home/case-context CaseOpenController@getContext
POST /home/case-history CaseOpenController@getHistory
POST /home/case-input-documents/info CaseOpenController@getInputDocumentInfo
POST /home/user-card CaseOpenController@getUserCard
GET /home/user-name-format CaseOpenController@getUserNameFormat
POST /home/case-input-documents/upload CaseOpenController@uploadInputDocuments
POST /home/case-messages CaseOpenController@getMessages
POST /home/case-messages/resend CaseOpenController@resendMessage
GET, POST /home/case-messages/attachment CaseOpenController@downloadMessageAttachment
POST /home/case-dynaforms CaseOpenController@getDynaforms
POST /home/case-change-log CaseOpenController@getChangeLog
POST /home/case-documents/uploaded CaseOpenController@getUploadedDocuments
POST /home/case-documents/generated CaseOpenController@getGeneratedDocuments
GET, POST /home/case-documents/download CaseOpenController@downloadDocument
POST /home/case-notes CaseOpenController@getNotes
POST /home/case-notes/create CaseOpenController@postNote
POST /home/case-notes/users CaseOpenController@getUsers
POST /home/case-claim CaseOpenController@claimCase
POST /home/case-actions CaseOpenController@getActions
POST /home/case-pause CaseOpenController@pauseCase
POST /home/case-unpause CaseOpenController@unpauseCase
POST /home/case-cancel CaseOpenController@cancelCase
POST /home/case-delete CaseOpenController@deleteCase
POST /home/case-reassign-users CaseOpenController@getReassignUsers
POST /home/case-reassign CaseOpenController@reassignCase
POST /home/case-derivation CaseOpenController@getDerivationData
POST /home/case-derivate CaseOpenController@executeDerivation

Búsqueda (2)

Método Ruta Acción
POST /search GlobalSearchController@search
POST /search/global GlobalSearchController@search

Favoritos e inicio de un caso (4)

Método Ruta Acción
POST /favorites/list FavoritesController@list
POST /favorites/save FavoritesController@save
POST /favorites/delete FavoritesController@delete
POST /favorites/launch FavoritesController@launch

Usuario actual (1)

Método Ruta Acción
POST /admin/me MeController@get

Descubrimiento de procesos (1)

Método Ruta Acción
POST /admin/processes/list ProcessController@list

Aprovisionamiento de usuarios (10)

Método Ruta Acción
POST /admin/users/groups-list SettingsController@groupsList
POST /admin/users/departments-list SettingsController@departmentsList
POST /admin/users/roles-list SettingsController@rolesList
POST /admin/users/list SettingsController@usersList
POST /admin/users/get SettingsController@usersGet
POST /admin/users/save SettingsController@usersSave
POST /admin/users/status SettingsController@usersStatus
POST /admin/users/test-username UserFormController@testUsername
POST /admin/users/search UserFormController@searchUsers
POST /admin/users/form-options UserFormController@formOptions

Regeneración

make api-endpoints