MENU navbar-image

Introduction

App works like laravel api + vuejs render. You can use this doc as quick start.

Only the main functions are described here. All functions available in vuejs are also available through api. Missing examples you can get through the network manager in the app

Base URL

https://{app}.admin.ux.im

Authenticating requests

This API is not authenticated.

File Manger

Initialize file manager

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/initialize',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/initialize" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET file-manager/initialize

Get files and directories for the selected path and disk

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/content',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'optio',
            'path' => 'nihil',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/content" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"optio\",
    \"path\": \"nihil\"
}"

Request   

GET file-manager/content

Body Parameters

disk  string optional  

path  string optional  

Directory tree

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/tree',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'ab',
            'path' => 'sed',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/tree" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"ab\",
    \"path\": \"sed\"
}"

Request   

GET file-manager/tree

Body Parameters

disk  string optional  

path  string optional  

Check the selected disk

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/select-disk',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'et',
            'path' => 'officiis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/select-disk" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"et\",
    \"path\": \"officiis\"
}"

Request   

GET file-manager/select-disk

Body Parameters

disk  string optional  

path  string optional  

Upload files

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/upload',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'consequatur',
            'path' => 'ullam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/upload" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"ullam\"
}"

Request   

POST file-manager/upload

Body Parameters

disk  string optional  

path  string optional  

Delete files and folders

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/delete',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'modi',
            'path' => 'quis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"modi\",
    \"path\": \"quis\"
}"

Request   

POST file-manager/delete

Body Parameters

disk  string optional  

path  string optional  

Copy / Cut files and folders

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/paste',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'eos',
            'path' => 'accusantium',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/paste" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"eos\",
    \"path\": \"accusantium\"
}"

Request   

POST file-manager/paste

Body Parameters

disk  string optional  

path  string optional  

Rename

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/rename',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'eum',
            'path' => 'molestias',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/rename" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"eum\",
    \"path\": \"molestias\"
}"

Request   

POST file-manager/rename

Body Parameters

disk  string optional  

path  string optional  

Download file

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/download',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'quis',
            'path' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"quis\",
    \"path\": \"et\"
}"

Request   

GET file-manager/download

Body Parameters

disk  string optional  

path  string optional  

Create thumbnails

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/thumbnails',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'ut',
            'path' => 'in',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/thumbnails" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"ut\",
    \"path\": \"in\"
}"

Request   

GET file-manager/thumbnails

Body Parameters

disk  string optional  

path  string optional  

Image preview

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/preview',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'accusamus',
            'path' => 'doloribus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/preview" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"accusamus\",
    \"path\": \"doloribus\"
}"

Request   

GET file-manager/preview

Body Parameters

disk  string optional  

path  string optional  

File url

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/url',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'facere',
            'path' => 'numquam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/url" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"facere\",
    \"path\": \"numquam\"
}"

Request   

GET file-manager/url

Body Parameters

disk  string optional  

path  string optional  

Create new directory

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/create-directory',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'commodi',
            'path' => 'quis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/create-directory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"commodi\",
    \"path\": \"quis\"
}"

Request   

POST file-manager/create-directory

Body Parameters

disk  string optional  

path  string optional  

Create new file

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/create-file',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'labore',
            'path' => 'placeat',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/create-file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"labore\",
    \"path\": \"placeat\"
}"

Request   

POST file-manager/create-file

Body Parameters

disk  string optional  

path  string optional  

Update file

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/update-file',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'minus',
            'path' => 'quo',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/update-file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"minus\",
    \"path\": \"quo\"
}"

Request   

POST file-manager/update-file

Body Parameters

disk  string optional  

path  string optional  

Stream file

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/stream-file',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'quo',
            'path' => 'id',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/stream-file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"quo\",
    \"path\": \"id\"
}"

Request   

GET file-manager/stream-file

Body Parameters

disk  string optional  

path  string optional  

Create zip archive

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/zip',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'sint',
            'path' => 'ea',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/zip" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"sint\",
    \"path\": \"ea\"
}"

Request   

POST file-manager/zip

Body Parameters

disk  string optional  

path  string optional  

Extract zip archive

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/file-manager/unzip',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'disk' => 'culpa',
            'path' => 'eaque',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/file-manager/unzip" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"disk\": \"culpa\",
    \"path\": \"eaque\"
}"

Request   

POST file-manager/unzip

Body Parameters

disk  string optional  

path  string optional  

Integration with ckeditor 4

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/ckeditor',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/ckeditor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET file-manager/ckeditor

Integration with TinyMCE v4

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/tinymce',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/tinymce" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET file-manager/tinymce

Integration with TinyMCE v5

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/tinymce5',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/tinymce5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET file-manager/tinymce5

Integration with SummerNote

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/summernote',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/summernote" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET file-manager/summernote

Simple integration with input field

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/file-manager/fm-button',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/file-manager/fm-button" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET file-manager/fm-button

Items

POST api/item/filter

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/api/item/filter',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'filter' => [
                'page' => 7,
                'perPage' => 12,
                'url' => '/cloth',
                'category' => 1,
                'priority' => false,
                'search' => 'aa',
                'price' => [
                    0,
                    100,
                ],
                'sortBy' => 'time',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/api/item/filter" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"filter\": {
        \"page\": 7,
        \"perPage\": 12,
        \"url\": \"\\/cloth\",
        \"category\": 1,
        \"priority\": false,
        \"search\": \"aa\",
        \"price\": [
            0,
            100
        ],
        \"sortBy\": \"time\"
    }
}"

Request   

POST api/item/filter

Body Parameters

filter  object optional  

filter.page  integer optional  

Default 1. Example:

filter.perPage  integer optional  

Items per page. Default 20. Example:

filter.url  string optional  

Category url.

filter.category  integer optional  

Category id.

filter.priority  boolean optional  

Is show on main page.

filter.search  string optional  

search %like% by title and description.

filter.price  integer[] optional  

[min_price, max_price].

filter.sortBy  enum optional  

available values: -p, +p, priority or time.

GET api/item/list

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/api/item/list',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/api/item/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET api/item/list

DELETE api/item/{id}

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://{app}.admin.ux.im/api/item/1',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request DELETE \
    "https://{app}.admin.ux.im/api/item/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

DELETE api/item/{id}

URL Parameters

id  integer  

The ID of the item.

Multisend

Check template message

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/api/multisend/self',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'id' => 10,
            'template' => [
                'src' => '<p>hi</p>',
                'settings' => [
                    'images' => [
                        [
                            'url' => 'placeat',
                            'id' => 'aut',
                        ],
                    ],
                    'button' => [
                        [
                            'link' => 'eos',
                            'text' => 'voluptatem',
                            'type' => 'webApp',
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/api/multisend/self" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"id\": 10,
    \"template\": {
        \"src\": \"<p>hi<\\/p>\",
        \"settings\": {
            \"images\": [
                {
                    \"url\": \"placeat\",
                    \"id\": \"aut\"
                }
            ],
            \"button\": [
                {
                    \"link\": \"eos\",
                    \"text\": \"voluptatem\",
                    \"type\": \"webApp\"
                }
            ]
        }
    }
}"

Request   

POST api/multisend/self

Body Parameters

id  integer optional  

Order id

template  object optional  

template.src  string optional  

HTML source.

template.settings  object optional  

template.settings.images  object optional  

template.settings.images[].url  string optional  

local path to image

template.settings.images[].id  telegram optional  

id upload file id

template.settings.button  object optional  

template.settings.button[].link  string optional  

template.settings.button[].text  string optional  

template.settings.button[].type  string optional  

.

GET api/multisend/{id}

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/api/multisend/1',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/api/multisend/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET api/multisend/{id}

URL Parameters

id  integer  

The ID of the multisend.

Options

List of all categories

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/api/options/categories',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/api/options/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET api/options/categories

DELETE api/options/{id}

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://{app}.admin.ux.im/api/options/1',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request DELETE \
    "https://{app}.admin.ux.im/api/options/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

DELETE api/options/{id}

URL Parameters

id  integer  

The ID of the option.

Option Settings

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://{app}.admin.ux.im/api/options/settings',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request GET \
    --get "https://{app}.admin.ux.im/api/options/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

GET api/options/settings

PUT api/options/settings

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://{app}.admin.ux.im/api/options/settings',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'id' => 11,
            'option_id' => 'et',
            'option' => 'molestias',
            'translate' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request PUT \
    "https://{app}.admin.ux.im/api/options/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"id\": 11,
    \"option_id\": \"et\",
    \"option\": \"molestias\",
    \"translate\": []
}"

Request   

PUT api/options/settings

Body Parameters

id  integer optional  

option_id  string optional  

option  string optional  

translate  object optional  

POST api/options/settings

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/api/options/settings',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'list' => [
                [
                    'id' => 12,
                    'option_id' => 'incidunt',
                    'option' => 'itaque',
                    'translate' => [],
                ],
            ],
            'remove' => [
                [
                    'id' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/api/options/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"list\": [
        {
            \"id\": 12,
            \"option_id\": \"incidunt\",
            \"option\": \"itaque\",
            \"translate\": []
        }
    ],
    \"remove\": [
        {
            \"id\": 2
        }
    ]
}"

Request   

POST api/options/settings

Body Parameters

list  object optional  

list[].id  integer optional  

list[].option_id  string optional  

list[].option  string optional  

list[].translate  object optional  

remove  object optional  

remove[].id  integer optional  

DELETE api/options/settings/{id}

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://{app}.admin.ux.im/api/options/settings/pariatur',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request DELETE \
    "https://{app}.admin.ux.im/api/options/settings/pariatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS"

Request   

DELETE api/options/settings/{id}

URL Parameters

id  string  

The ID of the setting.

Orders

POST api/order/filter

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://{app}.admin.ux.im/api/order/filter',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-TOKEN' => '6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS',
        ],
        'json' => [
            'id' => 13,
            'filter' => [
                'page' => 3,
                'perPage' => 3,
                'search' => '15',
                'status' => 'new',
                'pay_status' => [
                    'neque',
                ],
                'price' => [
                    0,
                    100,
                ],
                'created_at' => [
                    0,
                    1880001105,
                ],
                'sortBy' => 'time',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
curl --request POST \
    "https://{app}.admin.ux.im/api/order/filter" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-TOKEN: 6I92OcFRFBTEGx3INZs8pqk6LA0FXY3pdVZSsT2mS9oYqxAZjFaGBn998aALnufS" \
    --data "{
    \"id\": 13,
    \"filter\": {
        \"page\": 3,
        \"perPage\": 3,
        \"search\": \"15\",
        \"status\": \"new\",
        \"pay_status\": [
            \"neque\"
        ],
        \"price\": [
            0,
            100
        ],
        \"created_at\": [
            0,
            1880001105
        ],
        \"sortBy\": \"time\"
    }
}"

Request   

POST api/order/filter

Body Parameters

id  integer optional  

Works only id or filter

filter  object optional  

filter.page  integer optional  

Default 1. Example:

filter.perPage  integer optional  

Items per page. Default 20. Example:

filter.search  string optional  

search %like% by check_id,id or user_id.

filter.status  enum optional  

available values: new, process, progress, delivery, back.

filter.pay_status  string[] optional  

available values: [pay, npay].

filter.price  integer[] optional  

[min_price, max_price].

filter.created_at  integer[] optional  

[min_unix_timestamp, max_unix_timestamp].

filter.sortBy  enum optional  

available values: -p, +p or time.