Upload file
Query parameters:
none
Body:
Content Type | Value |
---|
multipart/form-data | |
Headers
Header | Value | Required |
---|
Accept | application/json | true |
Authorization | Your authorization token | true |
Channel | Your channel value | true |
x-api-version | 2.0 | true |
Request Example
curl -X POST "https://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.
Headers | Value |
---|
content-type | application/json; charset=utf-8 |
api-supported-versions | Supported versions. Example: 1.0, 2.0 |
Returned in case of request validation error.
Headers | Value |
---|
content-type | application/json; charset=utf-8 |
api-supported-versions | Supported versions. Example: 1.0, 2.0 |
Content Type | Value |
---|
application/json | |
Example body:
{
"errorMessage": "File not found"
}
Returned if the authentication credentials are incorrect or missing.
Content Type | Value |
---|
any | Depends on authentication proxy |
Returned in case of unpredictable error.
Headers | Value |
---|
content-type | application/json; charset=utf-8 |
api-supported-versions | Supported versions. Example: 1.0, 2.0 |
Content Type | Value |
---|
application/json | |
Example body:
{
"errorMessage": "Internal error"
}
Download file
Query parameters:
Header | Type | Description | Type |
---|
fileUid | string($uuid) | Unique local identifier for the file | string($uuid) |
Headers
Header | Value | Required |
---|
Accept | application/json | true |
Authorization | Your authorization token | true |
Channel | Your channel value | true |
x-api-version | 2.0 | true |
Request Example
curl -X GET"https://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.
Headers | Value |
---|
content-type | application/json; charset=utf-8 |
api-supported-versions | Supported versions. Example: 1.0, 2.0 |
content-disposition | Attachment; filename= |
Content Type | Value |
---|
application/x-binary | FileData |
Returned in case of request validation error.
Headers | Value |
---|
content-type | application/json; charset=utf-8 |
api-supported-versions | Supported versions. Example: 1.0, 2.0 |
Content Type | Value |
---|
application/json | |
Example body:
{
"errorMessage": "File not found"
}
Returned if the authentication credentials are incorrect or missing.
Content Type | Value |
---|
any | Depends on authentication proxy |
Returned in case of unpredictable error.
Headers | Value |
---|
content-type | application/json; charset=utf-8 |
api-supported-versions | Supported versions. Example: 1.0, 2.0 |
Content Type | Value |
---|
application/json | |
Example body:
{
"errorMessage": "Internal error"
}