Shareable links

>>>

GET /api/v2/shareable_links/:key
Get shareable link

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
key
required

Shareable link key

Validations:

  • Must be a String

Examples

// Successful request
GET /api/v2/shareable_links/faf0f631-c83c-4260-b1ae-b3bf7bfef01d
302
<html><body>You are being <a href="https://mediapocket-test-account-5.s3.eu-central-1.wasabisys.com/test_key?response-content-disposition=attachment%3B%20filename%3DAsset_file_name.test_key&amp;X-Amz-Algorithm=AWS4-HMAC-SHA256&amp;X-Amz-Credential=access-key-id-1%2F20231127%2Feu-central-1%2Fs3%2Faws4_request&amp;X-Amz-Date=20231127T094339Z&amp;X-Amz-Expires=900&amp;X-Amz-SignedHeaders=host&amp;X-Amz-Signature=0e2dad3d6ed639613b5adeeb1f317e05fc9b7d6de96c78a494c1eb632521a9e9">redirected</a>.</body></html>
// Shareable link not found
GET /api/v2/shareable_links/invalid_key
404
{
  "error": "Link not found or has expired"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/shareable_links
Create shareable link

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
expiry_date
required

Expiry date

Validations:

  • Must be a String
limit
required

Limit

Validations:

  • Must be a Integer
payload
required

Validations:

  • Must be a Hash
payload[media_id]
required

Media ID

Validations:

  • Must be a Integer
payload[filename]
required

Filename

Validations:

  • Must be a String

Examples

// Successful request
POST /api/v2/shareable_links
{
  "expiry_date": "2023-11-28",
  "limit": 5,
  "payload": {
    "asset_id": "b5Iix0ul_b2bTnT23Jo-",
    "filename": "test_file",
    "media_id": 4
  }
}
200
{
  "id": 4,
  "url": "https://test-account-5.devmediapocket.fi/api/v2/shareable_links/71f88dbe-13a9-485e-be99-0ac68bf849cc",
  "filename": "test_file"
}
// With invalid parameters
POST /api/v2/shareable_links
{
  "expiry_date": "2023-11-28",
  "limit": 5,
  "payload": {
    "asset_id": "invalid_id",
    "filename": "test_file",
    "media_id": 5
  }
}
400
{
  "error": "asset not found"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/shareable_links/share
Send shareable links by email

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
message
optional

Message

Validations:

  • Must be a String
recipients
required

Array of email addresses

Validations:

  • Must be an array of any type
shareable_link_ids
optional

Array of shareable link IDs

Validations:

  • Must be an array of any type

Examples

// Successful request
POST /api/v2/shareable_links/share
{
  "message": "This is an optional test message",
  "recipients": [
    "test1@testmail.test",
    "test2@testmail.test"
  ],
  "shareable_link_ids": [
    2
  ]
}
200
{
  "message": "Shareable links sent"
}
// With invalid parameters
POST /api/v2/shareable_links/share
{
  "message": "This is an optional test message",
  "recipients": [
    "test1@testmail.test",
    "test2@testmail.test"
  ],
  "shareable_link_ids": [
    "invalid_id"
  ]
}
400
{
  "error": "No shareable links found"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters