POST/api/files

Upload file

Query parameters:

none

Body:

Content TypeValue
multipart/form-data

Headers

HeaderValueRequired
Acceptapplication/jsontrue
AuthorizationYour authorization tokentrue
ChannelYour channel valuetrue
x-api-version2.0true

Request Example

curl -X POST "http://qrm1.kekker.com/api/files"
-H "accept: */*"
-H "Authorization: {AUTHORIZATION}"
-H "channel: {CHANNEL}"
-H "Content-Type: multipart/form-data"
-H "x-api-version: 2.0"
-F "formFile=offer.pdf;type=application/pdf"

Response

Returned if the request is successful. Response body is empty.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0

Returned in case of request validation error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "errorMessage": "File not found"
}

Returned if the authentication credentials are incorrect or missing.

Content TypeValue
anyDepends on authentication proxy

Returned in case of unpredictable error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
    "errorMessage": "Internal error"
}

GET/api/files/{fileUid}

Download file

Query parameters:

HeaderTypeDescriptionType
fileUidstring($uuid)Unique local identifier for the filestring($uuid)

Headers

HeaderValueRequired
Acceptapplication/jsontrue
AuthorizationYour authorization tokentrue
ChannelYour channel valuetrue
x-api-version2.0true

Request Example

curl -X GET"http://qrm1.kekker.com/api/files/c19131e4-b9c1-4dce-8cae-b8d00f50fc61"
-H "accept: */*"
-H "Authorization: {AUTHORIZATION}"
-H "channel: {CHANNEL}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful. Response body is empty.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
content-dispositionAttachment; filename=
Content TypeValue
application/x-binaryFileData

Returned in case of request validation error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "errorMessage": "File not found"
}

Returned if the authentication credentials are incorrect or missing.

Content TypeValue
anyDepends on authentication proxy

Returned in case of unpredictable error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
    "errorMessage": "Internal error"
}

Test the platform’s powerful features now

By submitting this form, you confirm that you have read and agree to our privacy policy and terms of service