Elvis 4 REST API - createAuthKey
|
GET/POST http://yourserver.com/services/createAuthKey
?subject=<subject>
&validUntil=<Expiry date>
&assetIds=<List of asset ids>
&description=<Description>
&downloadOriginal=<true|false>
&downloadPreview=<true|false>
&requestApproval=<true|false>
&requestUpload=<true|false>
&containerId=<Container asset id>
&importFolderPath=<Path where files are uploaded>
¬ifyEmail=<Email address>
&sort=<comma-delimited sort fields>
&viewMode=<thumbnail|list|mason?>
&thumbnailFields=<comma-delimited fields>
&listviewFields=<comma-delimited fields>
&filmstripFields=<comma-delimited fields>
&thumbnailZoomLevel=<Zoom level>
&listviewZoomLevel=<Zoom level>
&filmstripZoomLevel=<Zoom level>
|
What does it do?
Create an authKey in Elvis.
Using this API call it is posible to create authKeys.
Parameters
| subject |
AuthKey subject Required. |
| validUntil |
Expiry date, in one of the date formats supported by Elvis, see Searching for files in Elvis by using a query. Required. |
| assetIds |
Comma-delimited list of asset id's to share, do not specify for a pure upload request (requestUpload must be true is this case) Optional. |
| description |
AuthKey description that will be shown to receiver of the link. Optional. |
| downloadOriginal |
Allow downloading original files. Setting this to true will automatically force downloadPreview to true as well. Optional. Default is false. |
| downloadPreview |
Allow viewing and downloading previews. Setting this to false will only show thumbnails and will also force downloadOriginal to false. Optional. Default is false. |
| requestApproval |
Request for approval. Optional. Default is false. |
| requestUpload |
Allow uploading new files, must be true when asset id's is not specified. Optional. Default is false. |
| containerId |
Container asset id which uploaded files are related to. Only relevant when requestUpload=true. Optional. |
| importFolderPath |
folderPath where files are uploaded. Required when requestUpload=true. Optional. |
| notifyEmail |
Email address to send notifications to when upload or approval is finished. Only relevant when requestUpload=true or requestApproval=true. Optional. |
| sort |
Client setting, specify a comma-delimited list of fields to sort the results on. Follows the same behavior as sort in REST - search call, see also REST - search. Optional. |
| viewMode |
Client setting.
Optional. Default is thumbnail. |
| thumbnailFields |
Client setting, comma-delimited list of fieldnames for showing metadata in the thumbnail view. Optional. |
| listviewFields |
Client setting, comma-delimited list of fieldnames for showing metadata in the list view. Optional. |
| filmstripFields |
Client setting, comma-delimited list of fieldnames for showing metadata in the filmstrip view. Optional. |
| thumbnailZoomLevel |
Client setting, thumbnail zoom level in the thumbnail view. Optional. |
| listviewZoomLevel |
Client setting, thumbnail zoom level in the list view. Optional. |
| filmstripZoomLevel |
Client setting, thumbnail zoom level in the filmstrip view. Optional. |
Return value
A JSON object with name/value pairs. The following properties are returend.
| authKey | The authKey of the created shared link. |
| webClientUrl |
Share link url for the web client/share client. |
| desktopClientUrl |
Share link url for the desktop client. |
| mobileClientUrl |
Share link url for the mobile (iPad) client. |
Examples
|
createAuthKey http://demo.elvisdam.com/services/createAuthKey
?subject=subject
&assetIds=AOBKw_wRqYV8PQjdIoY1gx,FA9IVYMmaeXBiilboXPki3
&validUntil=1582306399999
|
This call creates an authKey with subject "subject" and assets with id's "AOBKw_wRqYV8PQjdIoY1gx" and "FA9IVYMmaeXBiilboXPki3", valid until 21/02/2020.
{
"authKey" : "qQ-1X1b",
"webClientUrl" : "http://demo.elvisdam.com?w=qQ-1X1b",
"desktopClientUrl" : "http://demo.elvisdam.com?e=qQ-1X1b",
"mobileClientUrl" : "elvis://demo.elvisdam.com?w=qQ-1X1b"
}Pure upload request
Exampe for creating a link with upload-only rights.
|
createAuthKey http://demo.elvisdam.com/services/createAuthKey
?subject=subject
&requestUpload=true
&importFolderPath=/Users/admin
&validUntil=1582306399999
|
This call creates an authKey with subject "subject", with allows uploading of assets to the path "/Users/admin" and is valid until 21/02/2020.
{
"authKey" : "aayy4ZE",
"webClientUrl" : "http://demo.elvisdam.com?w=aayy4ZE",
"desktopClientUrl" : "http://demo.elvisdam.com?e=aayy4ZE",
"mobileClientUrl" : "elvis://demo.elvisdam.com?w=aayy4ZE"
}
0 Comments