COMMAND.9 Create delivery authorization

Overview

This command creates a delivery authorization valid for a max number of retries (maxRetries parameter) and with a time to live (ttlInSeconds parameter). The create delivery authorization can be done ONLY by the owner of the content. This command might perform a redirection (redirect parameter) with the download URL. In this case it is not needed to call the download command (step nr. 2) because the download starts automatically by the redirection.

URI

/catramms/v1/delivery/:PhysicalPathKey?[:ttlInSeconds=120]&[:maxRetries=10]&[:redirect=false]&[:save=false]

Method

GET

URL Params

Required

PhysicalPathKey: key of the specific file to be authorized for the download

Optional

• ttlInSeconds: time to live in seconds of the authorization
  • default: 120
• maxRetries: max number of retries of the authorization
  • default: 10
• redirect: it specifies if this command has to perform a redirection or it has to return a json with several information including the URL to be used for the download of the content
  • default: false
• save: in case this parameter is true, the return delivery URL will contain the deliveryFileName parameter. When the delivery URL is called, this parameter cause the delivery server to add the Content-Disposition header in order to ask the client to save the downloaded file using deliveryFileName as file name. The deliveryFileName parameter is initialized using the 'deliveryFileName' metadata field decided by the user during the ingestion of the content or, in case this is empty, using the 'title' of the content.
  • default: false

Payload Data

None

Success Response

Code

• 301 Moved Permanently in case the redirect parameter is true
• 201 Created in case the redirect parameter is false

Content

Only in case the redirect parameter is false

{ 
    "deliveryURL": "https://mms-delivery.catrasoft.cloud/MMS_0000/CatraSoft/000/000/561/833_source.mp4?token=4&deliveryFileName=myName.mp4",
    "deliveryFileName": "myName.mp4", 
    "authorizationKey": 4, 
    "ttlInSeconds": 120, 
    "maxRetries": 10 
}

Error Response

See Common Error Responses

Sample Call

Assuming:

• UserKey: 5

• APIKey: SU1.8ZO1O2zVeBMNv9lzZ0whABXSAdjWrR~rpcnI5eaHNO2gysrNdAv8BNoWZB1eLP

• redirect=false (default)

• save=false (default)

  • curl -k -v -u 5:SU1.8ZO1O2zVeBMNv9lzZ0whABXSAdjWrR~rpcnI5eaHNO2gysrNdAv8BNoWZB1eLP https://mms-api.catrasoft.cloud/catramms/v1/delivery/663

• redirect=true

• save=true

  • curl -k -v -u 5:SU1.8ZO1O2zVeBMNv9lzZ0whABXSAdjWrR~rpcnI5eaHNO2gysrNdAv8BNoWZB1eLP -L https://mms-api.catrasoft.cloud/catramms/v1/delivery/663?redirect=true > myFileName.mp4