Media uploading
Swagger - detailed media API.
Media Upload Request Body Interface:
Format: multipart/form-data
{
"publicKey": "string",
"hash": "string",
"file": "binary"
}
Table Describing All Fields in the Request Body:
| Field | Type | Required | Description | |||||
|---|---|---|---|---|---|---|---|---|
| publicKey | String | Yes | Public key issued during merchant registration on the FirstPay platform (the key is provided as a file; the entire contents must be included). | |||||
| hash | String | Yes | Encoded request body string. For instructions on how to generate it, see the "Authorization" section. | |||||
| file | Binary | Yes | Binary media | |||||
Table of returned responses:
| code | Response body | Description |
|---|---|---|
| 200 | Media | Upon a successful request, media data is returned. |
| 400 | {"error": "some text here..."} | An error occurs if the request body and query parameters could not be parsed (most likely due to incorrect formatting). |
| 401 | {"error": "NO_LOGIN"} | An error occurs if the publicKey field is missing in the request body. |
| 401 | {"error": "NO_TOKEN"} | An error occurs if the hash field is missing in the request body. |
| 401 | {"error": "NO_KEY"} | An error occurs if an invalid publicKey is provided. |
| 401 | {"error": "UNAUTHORIZED"} | An error occurs if there is a validation error with the publicKey and hash. |
| 500 | {"error": "some text here..."} | An error occurs when the server fails to process the request due to an unexpected or non-standard situation. |
Media Fields Description
Uploaded Media Interface:
{
"id": "string",
"name": "string",
"size": "number",
"createdAt": "string"
}
Table Describing All Fields:
| Field | Type | Description | |||||
|---|---|---|---|---|---|---|---|
| id | String | Media ID. | |||||
| name | String | File name. | |||||
| size | Number | File size. | |||||
| createdAt | String | Creation date. | |||||