Demo

GET

Retrieves all demo accounts.

get

Query parameters

limitnumberOptional

The maximum number of records to return.

Example: 10

offsetnumberOptional

The number of records to skip.

Example: 0

Responses

200

Demo accounts retrieved successfully

application/json

403

Access denied

application/json

get

/demo

HTTPcURLJavaScriptPython

GET /demo HTTP/1.1
Host: 
Accept: */*

{
  "count": 10,
  "users": [
    {
      "id": 1,
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "previewLink": "encrypted_preview_link"
    }
  ]
}

POST

Creates a new demo account.

post

Body

application/json

emailstringOptionalExample: [e-mail]

firstNamestringOptionalExample: John

lastNamestringOptionalExample: Doe

passwordstring | nullableOptionalExample: securePassword123

Responses

201

Demo account created successfully

application/json

400

User with such email already registered

application/json

403

Access denied

application/json

post

/demo/account

HTTPcURLJavaScriptPython

POST /demo/account HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "password": "securePassword123"
}

{
  "id": 1,
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "previewLink": "encrypted_preview_link"
}

Validates a preview link by decrypting the hash.

post

Responses

200

Preview link validated successfully

application/json

400

Invalid hash

application/json

post

/demo/preview

HTTPcURLJavaScriptPython

POST /demo/preview HTTP/1.1
Host: 
Accept: */*

[e-mail];password

Resets a demo account by its ID.

post

Path parameters

idnumberRequired

Responses

200

Demo account reset successfully

application/json

400

Invalid account ID

application/json

403

Access denied

application/json

404

Demo account not found

application/json

post

/demo/account/reset/{id}

HTTPcURLJavaScriptPython

POST /demo/account/reset/{id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Demo account reset successfully",
  "description": "The demo account has been reset successfully."
}

Uploads a file to the S3 bucket.

post

Body

application/json

filestring · binaryOptional

Responses

200

File uploaded successfully

application/json

400

Invalid file

application/json

post

/action-demo-files

HTTPcURLJavaScriptPython

POST /action-demo-files HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

formatted_file_name.jpg

PATCH

Edits an existing demo account.

patch

Path parameters

idnumberRequired

Body

application/json

emailstringRequiredExample: [e-mail]

firstNamestringRequiredExample: John

lastNamestringRequiredExample: Doe

passwordstring | nullableRequiredExample: securePassword123

Responses

200

Demo account edited successfully

application/json

400

User with such email already registered

application/json

403

Access denied

application/json

patch

/demo/account/{id}

HTTPcURLJavaScriptPython

PATCH /demo/account/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "password": "securePassword123"
}

{
  "id": 1,
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "previewLink": "encrypted_preview_link"
}

DELETE

Deletes a demo account by its ID.

delete

Path parameters

idnumberRequired

Responses

200

Demo account deleted successfully

application/json

400

Invalid account ID

application/json

403

Access denied

application/json

404

Demo account not found

application/json

delete

/demo/account/{id}

HTTPcURLJavaScriptPython

DELETE /demo/account/{id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Demo account deleted successfully",
  "description": "The demo account has been deleted successfully."
}

Deletes a file by its name from the S3 bucket.

delete

Path parameters

fileNamestringRequired

Responses

200

File deleted successfully

application/json

404

File not found

application/json

500

Internal server error

application/json

delete

/action-demo-files/{fileName}

HTTPcURLJavaScriptPython

DELETE /action-demo-files/{fileName} HTTP/1.1
Host: 
Accept: */*

{
  "message": "File deleted successfully",
  "description": "The file has been deleted successfully."
}