The API shortcuts provide a group of methods and URLs used simply to redirect the user to internal UKG HR Service Delivery URLs, often with a more complex structure. These URLs may be used in particular when the SSO is used (see SSO API for UKG HR Service Delivery modules, in the parameter next).
The responses of this API are always of the 302 temporary redirect type. For example:
HTTP/1.1 302 Found
Location: https://{domain}.safe-access.com/company/employee/22624/folder/
The following URLs redirect to the pages accessible to the managers, that is users with a Document Manager account.
Warning
To access to these pages the user has to be connected as a manager.
The user is redirected to the employee folder of the employee identified by the parameter employee_id
URL:
GET /api/v1/url/manager/employee/folder/
The user is redirected to the document upload form (as for the previous URL), and the field type of document is pre-filled.
URLS:
GET /api/v1/url/manager/documents/upload/?doc_type={identifiant_du_type_de_document_bulletin_de_paie}
The following URLs allow an employee to access or complete his/her own employee folder. These URLs are available on UKG HR Service Delivery settings.
Warning
To access to these pages the user has to be connected as an employee.
Note
The employee space accessed by the employee to visualise his employee folder is different from his private safe
Note
The employee can consult all, or only a part of his employee folder documents. The visibility of the documents is determined during the document types configuration phase. It can be edited anytime from an administrator account.
URL:
GET /api/v1/url/employee/documents/?doc_type={identifiant_du_type_de_document_bulletin_de_paie}
The employee is redirected towards an upload form in the employee folder
URL:
GET /api/v1/url/employee/documents/upload/
The employee is redirected to the upload form of a document in the employee folder (as for the previous URL), and the field type of document is pre-filled.
URL:
GET /api/v1/url/employee/documents/upload/?doc_type={identifiant_du_type_de_document_RIB}