- Resource functions
-
- get_resource_field_data
- create_resource
- delete_resource
- copy_resource
- get_resource_log
- update_resource_type
- get_resource_path
- get_resource_data
- get_alternative_files
- get_resource_types
- add_alternative_file
- delete_alternative_file
- upload_file
- upload_file_by_url
- upload_multipart
- get_related_resources
- resource_log_last_rows
- replace_resource_file
- get_resource_all_image_sizes
- put_resource_data
- update_related_resource
- relate_all_resources
- get_edit_access
- Collection functions
- Search functions
- IIIF
- Metadata functions
- User functions
- Message functions
- Plugin functions
login
Login with user name and password to retrieve a session API key
This key can be used to generate the sign value for subsequent API calls with the 'authmode' parameter set to 'sessionkey'. Refer to the main API documentation for an example
| Variable | Description | Data type |
|---|---|---|
| $username * | The username | string |
| $password * | The current password | string |
Return values
A session API key in string form if the login succeeds, FALSE if the credentials are invalid