Skip to content

eggcho/kcdn

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
Readme.md
Readme.md
 
 

Repository files navigation

Login

Authenticates the user and generates API token.

The user credentials are passed in the request header as HTTP Basic Auth string.

As a result of the method the user data and access token are returned.

The input parameters for this method are sent in form of HTTP Basic Authentication.

As the Authentication parameter is sent in the Request Header, the HTTP method is not important but for consistency only GET and POST are allowed.

In case of successfull login a bearer token will be sent. It can be used instead of the actual user password in all consequtive request

API Endpoint

GET /api/auth/login

Parameters:

Name Type Description
Auth Username String Login name of the user
Auth Password String User inserted password

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error.
message String Human-readable result message.
Id Integer User internal identificator.
user String User login.
name String Screen name of the user.
phone String Contact phone.
email String Contact email.
role Integer User access level.
pop String Default user instance.
token String Session access token. Can be used instead of password in all consequtive requests.

Response codes:

Code Name Description
200 Success The directory list is retrieved
204 No results The applied filters produce an empty result-set
400 Error If an error occurs, the API returns a JSON object with result set to 400 and message set to an error message.

Example Request

curl http://dev.k.cdn.bg/api/auth/login/ -G \
        -u api_user:api_password

Example Responce

{
    "result": 200,
    "message": "Success",
    "data": {
        "Id": 13,
        "name": "kalin",
        "phone": "02-969-1540",
        "email": "knikolov@evolink.com",
        "role": 9,
        "pop": "sof",
        "token": "eyJ0eXAiOiJKV1QiLCJerteertJIUzI1NiJ9.eyJ1c2VyaWQiOiIxMyIsImlhdCI6MTY4NzI0MjA1MX0.U79Cb_8e2OZJn_2GUByPk96mR3pUtveGdOMPAWFa1-I"
    }
}

User

User Statuses

Status Description User Admin Reseller Support
0 Not Activated - x - -
1 Active - x - -
2 Reserved - x - -
3 Reserved - x - -
4 Reserved - x - -
5 Reserved - x - -
6 Reserved - x - -
7 Reserved - x - -
8 Suspended - x - -
9 Deleted - x - -

Admins Only : If status of user is changed to anything else than Active (1), all his applications goes Suspended with status 4(Previously Disabled) or 5 (Previously Enabled). When status of user is changed again to Active (1), all previously suspended applications, goes in their reagular state. 4 -> Disabled, 5 -> Enabled.

Users cannot change their status!

User Roles

Role Description User Admin Reseller Support
0 Admin - x - -
1 Reserved - x - -
2 Reserved - x - -
3 Reserved - x - -
4 Reserved - x - -
5 Reserved - x - -
6 Reserved - x - -
7 Reserved - x - -
8 Reserved - x - -
9 User x x - -

Admin Only : Only Admins can change user role. At this time (04.07.2023), changing role isn't supported, to admin too!

Users cannot change their role!

Create User

Endpoint: POST /api/user/

This endpoint is used to create a new user in the system.

Parameters

Name Type Description
username String The desired username for the new user. Only characters, numbers, underscore and dash are allowed. This is a required field
email String The email address of the new user. This is a required field
password String The password for the new user. This is a required field
fullname String The full name of the user. Only characters, numbers, underscore, dash and space are allowed. This is optional
phone String The phone number of the user. Only numbers and dash are allowed. This is optional
location String POP location. This is optional and default is 'sof'

Output data

Parameter Type Description
userid Integer The internal identifier of the user
username String The username of the new user
activation_code String The activation code for the new user
valid_until DateTime The expiration time for the activation code
email String The email address of the new user

Response codes

Code Name Description
200 Success The user is created!
400 Bad request One of the parameters is missing or incorrect
409 Conflict Username or email already exists
500 Internal error The user cannot be created due to an error in the server

Example Request

curl http://dev.k.cdn.bg/api/user/ -X POST \
	-d '{"username": "client_username", "email" : "email@example.com" ,"password" : "Secret_password_of_user", "fullname" : "First Last" , "phone" : "+359 555 123 123", "location" : "sof"}'

Example Response

{
    "result": 200,
    "message": "User added successfully.",
    "data": {
        "userid": 34,
        "username": "client_username",
        "activation_code": "246e3c099b6f9157773ce6aa43fb3034e8ce6eb1dc957db4f22626b775ccd386",
        "valid_until": "2023-07-02 11:20:41",
        "email": "email@example.com"
    }
}

Activate User

Endpoint: GET /api/user/activation/{activation_code}

This endpoint activates a user account on the site. To activate a user, it is necessary to supply the activation code which was sent to the user's email.

Note

Only users can activate their accounts using their activation code.

Parameters

Name Type Description
activation_code String Activation code sent to the user's email. This is a required field

Response codes

Code Name Description
200 Success User activated successfully
400 Bad request Invalid activation code or the activation code is already used
500 Internal error Error in execution on the server side

Example Request

curl http://dev.k.cdn.bg/api/user/activation/1z2x3c4v5b6n7m89o0p1qw2e3r45ty6yvfgfr43fd45g

or

curl http://dev.k.cdn.bg/api/user/activation/ -G \
-d "activation_code=1z2x3c4v5b6n7m89o0p1qw2e3r45ty6yvfgfr43fd45g"

Example Response

{
    "result": 200,
    "message": "User activated successfully",
    "data": {
        "userid": 38
    }
}

Example Response (Error)

{
    "result": 400,
    "message": "Invalid activation code"
}

Fetching Users List

Endpoint: GET /api/user/list

Admin Only This endpoint retrieves a list of users based on specific filters, order, limit, and offset parameters.

Parameters

Name Located in Description Required Type
Authorization header Bearer token received after authentication. Yes String
filter query This parameter allows filtering of the user list based on specific fields. The field and its value should be specified in the format filter[field]=value. Wildcards are allowed by using the asterisk symbol. For example, filter[username]=*name* will return users whose username contains 'iv'. Multiple filters can be specified. No String
limit query This parameter specifies the maximum number of users to return in the response. Default is 10. Maximum value is 100. No Integer
offset query This parameter specifies the number of users to skip before starting to collect the set of returned users. Default is 0 No Integer
order query This parameter allows ordering of the returned users based on a specific field. The order should be specified in the format order=field.direction. For example, order=userid.desc will return users ordered by user ID in descending order. Default is userid.asc No String

Filter and Order parameters

userid, username, fullname, email, role, pop, status, phone

Order Directions

ASC or DESC

Responses

Status Description
200 Successful operation. Returns list of users.
400 Bad request. Incorrect parameters.
401 Unauthorized. No permissions.
500 Internal server error.

Example Request

curl http://dev.k.cdn.bg/api/user/list -G \
    -H "Authorization: Bearer <your_token>" \
    -d "filter[username]=*iv*" \
    -d "limit=10" \
    -d "offset=0" \
    -d "order=userid.desc"

Example Response

{
    "result": 200,
    "message": "Success",
    "meta": {
        "filter": {
            "username": "*iv*"
        },
        "order": "userid.desc",
        "offset": 0,
        "limit": 10,
        "count": 3,
        "total": 3
    },
    "data": {
        "27": {
            "id": 27,
            "username": "ivi2w",
            "fullname": "",
            "email": "ivsi@gmail.com",
            "phone": "",
            "role": 9,
            "pop": "sof",
            "status": 1
        },
        "26": {
            "id": 26,
            "username": "ivi2",
            "fullname": "",
            "email": "ivi@gmail.com",
            "phone": "",
            "role": 9,
            "pop": "sof",
            "status": 1
        },
        "12": {
            "id": 12,
            "username": "ivi",
            "fullname": "",
            "email": "iivanov@evolink.com",
            "phone": "888-999-999",
            "role": 9,
            "pop": "sof",
            "status": 1
        }
    }
}

or

{
    "result": 400,
    "message": "Invalid filter parameter. Please use one or more of the following keys: userid, username, fullname, email, role, pop, status, phone."
}

Fetching User Information

Endpoint: GET /api/user/{userid}

This endpoint retrieves the information of a specific user. The user ID is required in the endpoint as a path parameter.

Note: User Info is not cascading.

Parameters

Name Located in Description Required Type
Authorization header Bearer token received after authentication. Yes String
userid path The unique identifier of the user. Yes Integer

Responses

Status Description
200 Successful operation. Returns user's information.
400 Bad request. User not found.
401 Unauthorized. No permissions.
500 Internal server error.

Example Request

curl http://dev.k.cdn.bg/api/user/13 -G \
    -H "Authorization: Bearer <your_token>"

Example Respnses

{
    "result": 200,
    "message": "User Information.",
    "data": {
        "id": 18,
        "username": "test",
        "fullname": "",
        "email": "test@gmail.com",
        "phone": "",
        "status": 1,
        "role": 9,
        "pop": "sof"
    }
}

or

{
    "result": 400,
    "message": "User not found."
}

Edit User Details

Endpoint: PATCH /api/user/{userid}

This endpoint allows you to update user details. For general users, they can update their own details such as phone number and full name. For admin role, they can update the details of other users including user role and status.

Note: User update is not cascading.

Parameters

Name Type Description
Authorization Header String Bearer token received after authentication
userid (for Admin only) Integer ID of the user. This is a required field for admin
phone String User's updated phone number. This is a required field
fullname String User's updated full name. This is a required field
role (for Admin only) Integer User's updated role. For admin role, this is a required field. See table above
status (for Admin only) Integer User's updated status. For admin role, this is a required field. See table above

Admins Only : If status of user is changed to anything else than Active (1), all his applications goes Suspended with status 4(Previously Disabled) or 5 (Previously Enabled). When status of user is changed again to Active (1), all previously suspended applications, goes in their reagular state. 4 -> Disabled, 5 -> Enabled.

Users cannot change their status!

Output data

| Parameter | Type | Description | | result | Integer | Result code of the operation | | message |String | Details about the result of the operation | | data | JSON Object | Contains the updated user data |

Response codes

Code Name Description
200 Success The user details are updated successfully
400 Bad request There were errors during the process or one of the parameters is missing, empty, or invalid
401 Unauthorized Incorrect token or no permissions

Example Request

For general users:

curl http://dev.k.cdn.bg/api/user/13 -X PATCH \
    -H "Authorization: Bearer <your_token>" \
    -d '{ "phone" : "123-456-789", "fullname": "Name Family"}'

For Admins:

curl http://dev.k.cdn.bg/api/user/13 -X PATCH \
    -H "Authorization: Bearer <your_token>" \
    -d '{"userid": 13, "phone" : "888-570-543", "role" : 9, "status" : 1}'

Example Respnses

{
    "result": 200,
    "message": "User details updated successfully.",
    "data": {
        "userid": 13,
        "phone": "123-456-789",
        "fullname": "Name Family",
        "role": 9,
        "status": 1
    }
}

or

{
    "result": 400,
    "message": "Invalid parameters. Please check your inputs."
}

or

{
    "result": 200,
    "message": "User information updated successfully.",
    "data": {
        "id": 13,
        "username": "user_name",
        "fullname": "Name Family",
        "email": "username@example.com",
        "phone": "123-456-789",
        "status": 1,
        "role": 9,
        "pop": "sof"
    },
    "applications": {
        "fls10070": {
            "result": 200,
            "message": "App Enabled successfully."
        },
        "fls10071": {
            "result": 200,
            "message": "App Enabled successfully."
        },
        "vod10007": {
            "result": 200,
            "message": "App Enabled successfully."
        }
    }
}

Fetching User Roles

Endpoint: GET /api/user/roles/

This endpoint retrieves the roles of users. No parameters are required in this endpoint.

Note: Roles info is not cascading.

Parameters

Name Located in Description Required Type
Authorization header Bearer token received after authentication. Yes String

Responses

Status Description
200 Successful operation. Returns roles information.
400 Bad request. Roles not found.
401 Unauthorized. No permissions.
500 Internal server error.

Example Request

curl http://dev.k.cdn.bg/api/user/roles/ -G \
    -H "Authorization: Bearer <your_token>"

Example Response

{
    "result": 200,
    "message": "User Roles Information.",
    "data": {
        "Role_0": {
            "name": "admin",
            "role": 0,
            "description": "Administrator"
        },
        "Role_1": {
            "name": "Reserved",
            "role": 1,
            "description": "Reserved"
        },
        "Role_2": {
            "name": "Reserved",
            "role": 2,
            "description": "Reserved"
        },
        "Role_3": {
            "name": "Reserved",
            "role": 3,
            "description": "Reserved"
        }
    }
}

Fetching User Statuses

Endpoint: GET /api/user/statuses/

This endpoint retrieves the statuses of users. No parameters are required in this endpoint.

Note: User statuses info is not cascading.

Parameters

Name Located in Description Required Type
Authorization header Bearer token received after authentication. Yes String

Responses

Status Description
200 Successful operation. Returns user statuses information.
400 Bad request. User statuses not found.
401 Unauthorized. No permissions.
500 Internal server error.

Example Request

curl http://dev.k.cdn.bg/api/user/statuses/ -G \
    -H "Authorization: Bearer <your_token>"

Example Response

{
    "result": 200,
    "message": "User Status Information.",
    "data": {
        "Status_0": {
            "id": 0,
            "name": "Not Activated",
            "status": 0,
            "description": "User need to activate his account trough activation link."
        },
        "Status_1": {
            "id": 1,
            "name": "Active",
            "status": 1,
            "description": "User is Enabled and there is no limit to him."
        },
        "Status_8": {
            "id": 8,
            "name": "Suspended",
            "status": 8,
            "description": "User account is in suspended mode."
        },
        "Status_9": {
            "id": 9,
            "name": "Deleted",
            "status": 9,
            "description": "User and his application are removed from CDN!"
        }
    }
}

Create User Token

Endpoint: POST /api/auth/token

This endpoint adds a branch to the site's structure. To create a user bearer token, it is necessary to supply its UserID and its location parameters, respectively.

Note

Admins can create tokens for other users. Users can create tokens for them only.

Parameters

Name Type Description
userid Integer ID of the user. This is a required field
location String POP location. This is a required field

Output data

Parameter Type Description
Id Integer The internal identifier of the directory

Response codes

Code Name Description
200 Success The token is created!
400 Bad request One of the parameters is missing or empty
401 Unauthorized Incorrect authentication or No permissions
500 Internal error The section cannot be created due to an error in the server

Example Request

curl http://dev.k.cdn.bg/api/auth/token/ -X POST \
    -H "Authorization: Bearer <your_token>" \
	-d '{"userid": 13, "location": "sof"}'

Example Response

{
    "result": 200,
    "message": "Token has been created",
    "data": {
        "userid": "18",
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyaWQiOiIxNCIsImlhdCI6MTY4NzI0OTk2OX0.9PBqDM-5yY8uRESS2BGOG5RWCv4Rw3_bTjXYIguWe6I"
    }
}

Get User Token

Endpoint: GET /api/auth/token

Description:

This API endpoint returns a list of tokens for specific userid.

Note

Admins can get tokens for other users. Users can get only their tokens.

Parameters:

Name Type Description
userid Integer ID of the user. This is a required field
Location String POP location

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error
message String Human-readable result message
meta Object Meta data object of the result returned
data Hash A list of Directory objects. The key of the Hash is the ID of the directory

Response codes:

Code Name Description
200 Success The directory list is retrieved
204 No results No tokens for given user
401 Unauthorized Incorrect authenication or No permissions
500 Internal error The section cannot be created due to an error in the server

Example Request:

To get all directories with parent ID = 3, ordered by path in ascending order, you can use:

curl http://dev.k.cdn.bg/api/auth/token/ -G \
    -H "Authorization: Bearer <token>"
	-d 'userid=18' \
    -d 'location=sof'

Example Response:

{
    "result": 200,
    "message": "Tokens retrieved successfully",
    "data": {
        "userid": "18",
        "tokens": [
            {
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyaWQiOiIxNCIsIm7hdCI6MTY4NzI0ODU5MX0.piTyeGy6W9hlC55e8DKznHcjsVzMsG3oHG8vknGS8IU",
                "created_time": "2023-06-20 08:09:51"
            },
            {
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyaWQiOiIxNCIsIm7hdCI6MTY4NzI0OTk2MX0.bSsqgI78M79-G4ZwIlQnQyHkdJd-GT0u_uHF2xbapbc",
                "created_time": "2023-06-20 08:32:41"
            },
            {
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyaWQiOiIxNCIsIm7hdCI6MTY4NzI0OTk2M30.U3EMUT_6V4OCk3yOW2QboWCT_S9A7eQUradGsUFaRl0",
                "created_time": "2023-06-20 08:32:43"
            },
            {
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyaWQiOiIxNCIsIm7hdCI6MTY4NzI0OTk2OX0.9PBqDM-5yY8uRESS2BGOG5RWCv4Rw3_bTjXYIguWe6I",
                "created_time": "2023-06-20 08:32:49"
            }
        ]
    }
}

Creating a Live (FLS) Application

POST /api/application/fls/

This endpoint allows you to create a new live (FLS) application. You will need to provide the user's ID, the name of the application, and the desired location for the application.

Parameters

Name Type Description
Authorization Header String Bearer token received after authentication
userid Integer ID of the user. This is a required field
name String Name of the application. This is a required field
location String The desired location for the application. This is a required field

Output data

Parameter Type Description
appid Integer The internal identifier of the application
userid Integer The ID of the user who created the application
name String The name of the application
active Integer The status of the application (0 for inactive, 1 for active)
security_template Integer The security template of the application (default is 1)
podData Object Information about the pod resources created for the application

Response codes

Code Name Description
200 Success The application is created!
400 Bad request One of the parameters is missing or empty
401 Unauthorized Incorrect username or password
500 Internal error The application cannot be created due to an error in the server

Example Request

curl  http://dev.k.cdn.bg/api/application/fls/ -X POST \
    -H "Authorization: Bearer <your_token>" \
	-d '{"userid": 13, "name": "Real-App-3", "location": "sof"}'

Example Responce

{
    "result": 200,
    "message": "Application created successfully",
    "data": {
        "appid": 10061,
        "userid": 13,
        "name": "Real-App-3",
        "active": "0",
        "security_tempate": 1
    },
    "podData": {
        "services": "ifls_pod, ofls_pod, ifls_service, ofls_service",
        "status": "success, success, success, success",
        "httpcode": "201, 201, 201, 201"
    }
}

FLS Applications Listing

GET /api/application/fls

Description:

This API endpoint returns a list of FLS Application objects associated with a user, based on the given parameters, or an empty result set.

Parameters:

Name Type Description
Authorization Header String Bearer token received after authentication
filter Hash List filter. Mandatory Filters: userid, location. Additional filtering by the following fields is possible: status, name
order String List order. Ordering by the following fields is possible: appid, userid, name, active, security_template (asc or desc). Example: name.asc or appid.desc
offset Integer Result-set offset, used in pagination. Default = 0
limit Integer Result-set records count. Default = 10

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error
message String Human-readable result message
meta Object Meta data object of the result returned, including filter parameters, order, offset, limit, count of results in the set and total results
data Array A list of FLS Application objects or a message if no application found

Response codes:

Code Name Description
200 Success The applications list is retrieved
204 No results The applied filters produce an empty result-set
400 Bad request Invalid request parameters

Example Request:

To get all applications associated with user ID 13 and location 'sof', ordered by name in ascending order, you can use:

curl http://dev.k.cdn.bg/api/application/fls/ -G \
    -H "Authorization: Bearer <your_token>" \
    -d 'filter[userid]=13' \
    -d 'filter[location]=sof' \
    -d 'order=name.asc'

Example Response:

{
    "result": 200,
    "message": "Success",
    "meta": {
        "filter": {
            "userid": 13,
            "location": "sof"
        },
        "order": "name.asc",
        "offset": 0,
        "limit": 10,
        "count": 6,
        "total": 6
    },
    "data": [
        {
            "appid": 10006,
            "userid": 13,
            "name": "FLS Application 1",
            "active": "1",
            "security_template": 1,
        },
        {
            "appid": 10007,
            "userid": 13,
            "name": "FLS Application 2",
            "active": "0",
            "security_template": 0,
        },
        // additional application objects...
    ]
}

Updating FLS Application Parameters

PATCH /api/application/fls/{appid}

This endpoint allows you to update parameters of an existing application. You will need to provide the user's ID, the location of the application, and the application ID.

Note: Application update is not cascading.

Parameters

Name Located in Description Required Type
Authorization Header Bearer token received after authentication. Yes String
userid Body & URL ID of the user. Yes Integer
appid Body ID of the application. This is a required field Yes String
name Body Name of the application. This is a required field Yes String
location Body The desired location for the application. Yes String
active Body The active status of the application. For user role, can only be 0 or 1. For admin role, can be any integer from 0 to 9 Yes Integer
security_template Body The security template ID. Must belong to the user and exist in the database Yes Integer

Active parameter

Parameter Type Description User Admin Reseller Support
0 Integer Disable x x x x
1 Integer Enable x x x x
2 Integer Prohibited - x - -
3 Integer Reserved - x - -
4 Integer Suspend - Disable - x - -
5 Integer Suspend - Enable - x - -
6 Integer Reserved - x - -
7 Integer Reserved - x - -
8 Integer Reserved - x - -
9 Integer Deleted - x - -

Admins Only : If status of user is changed to anything else than Active (1), all his applications goes Suspended with status 4(Previously Disabled) or 5 (Previously Enabled). When status of user is changed again to Active (1), all previously suspended applications, goes in their reagular state. 4 -> Disabled, 5 -> Enabled.

Output data

Parameter Type Description
result Integer Result code of the operation
message String Details about the result of the operation
data JSON Object Contains the updated application data

Response codes

Code Name Description
200 Success The application is updated successfully!
400 Bad request There were errors during the process or one of the parameters is missing, empty, or invalid
401 Unauthorized Incorrect token or no permissions

Example Request

curl http://dev.k.cdn.bg/api/application/fls/10058 -X PATCH \
    -H "Authorization: Bearer <your_token>" \
    -d '{"userid": 13, "location": "sof", "appid": 10066, "name": "New_App_Name", "active": 1, "security_template": 5}'

Example Response:

Change status to ENABLE

{
    "result": 200,
    "message": "Application updated successfully.",
    "data": {
        "appid": 10071,
        "userid": 13,
        "name": "Patch_99",
        "active": "1",
        "security_template": 3
    },
    "pod": {
        "services": "ifls_pod, ofls_pod, ifls_service, ofls_service",
        "status": "success, success, success, success",
        "httpcode": "201, 201, 201, 201"
    }
}

or

Change status to DISABLE

{
    "result": 200,
    "message": "Application updated successfully.",
    "data": {
        "appid": 10071,
        "userid": 13,
        "name": "Patch_99",
        "active": "0",
        "security_template": 0
    },
    "pod": {
        "result": 200,
        "message": "App disabled successfully."
    }
}

or

Status not changed

{
    "result": 200,
    "message": "Application updated successfully.",
    "data": {
        "appid": 10070,
        "userid": 13,
        "name": "Patch_99",
        "active": "0",
        "security_template": 0
    },
    "pod": "Preserve current status!"
}

or

{
    "result": 400,
    "message": "Invalid Active value. Users can not change active value. Administratively prohibited."
}

or

{
    "result": 400,
    "message": "The security template does not belong to the user."
}

Deleting FLS Application

Endpoint DELETE /api/application/fls/{appid}**

This endpoint allows you to delete an existing application. You will need to provide the user's ID, the location of the application, and the application ID.

Note: Application deletion is not cascading.

Parameters

Name Located in Description Required Type
Authorization Header Bearer token received after authentication. Yes String
userid Body & URL ID of the user. Yes Integer
appid Body ID of the application. This is a required field Yes String
location Body The desired location for the application. Yes String

Output data

Parameter Type Description
result Integer Result code of the operation
message String Details about the result of the operation

Response codes

Code Name Description
200 Success The application is deleted successfully!
400 Bad request There were errors during the process or one of the parameters is missing or empty
401 Unauthorized Incorrect token or no permissions

Example Request

curl http://dev.k.cdn.bg/api/application/fls/10066 -X DELETE \
    -H "Authorization: Bearer <your_token>" \
    -d '{"userid": 13, "location": "sof","appid": 10066}'

Example Response:

{
    "result": 200,
    "message": "App deleted successfully."
}

or

{
    "result": 400,
    "message": "Errors occurred: \nPod: An error occurred while deleting the Pod 'ifls10065'. HTTP Status Code: 404\nPod: An error occurred while deleting the Pod 'ofls10065'. HTTP Status Code: 404\nService: An error occurred while deleting the Service 's-ifls10065'. HTTP Status Code: 404\nService: An error occurred while deleting the Service 's-ofls10065'. HTTP Status Code: 404\n"
}

This markdown document provides all the details to use the endpoint correctly, from the necessary parameters to the response structure, as well as example request and response.

Creating a VoD (VOD) Application

Endpoint: POST /api/application/vod/

This endpoint allows you to create a new VoD (VOD) application. You will need to provide the user's ID, the name of the application, and the desired location for the application. Optional you can specify webhook, where client to receive notification when files are transcoded.

Parameters

Name Located in Description Required Type
Authorization Header Bearer token received after authentication. Yes String
userid Body ID of the user. Yes Integer
name Body Name of the application. This is a required field Yes String
location Body The desired location for the application. Yes String
webhook Body Webhook to receive notification about processing of files. No String

Output data

Parameter Type Description
appid Integer The internal identifier of the application
userid Integer The ID of the user who created the application
name String The name of the application
active Integer The status of the application (0 for inactive, 1 for active)
security_template Integer The security template of the application (default is 1)
podData Object Information about the pod resources created for the application

Response codes

Code Name Description
200 Success The application is created!
400 Bad request One of the parameters is missing or empty
401 Unauthorized Incorrect username or password
500 Internal error The application cannot be created due to an error in the server

Example Request

curl  http://dev.k.cdn.bg/api/application/vod/ -X POST \
    -H "Authorization: Bearer <your_token>" \
	-d '{"userid": 36, "name": "News-VoD", "location": "sof", "webhook" : "http://dev.k.cdn.bg/test/webhook/cust36a"}'

Example Response

{
    "result": 200,
    "message": "Application created successfully",
    "data": {
        "appid": 10014,
        "userid": 36,
        "name": "News-VoD",
        "security_template": 0,
        "active": 1,
        "source_s3_cred_id": 11,
        "dest_s3_cred_id": 12,
        "customer_webhook": "http:\/\/dev.k.cdn.bg\/test\/webhook\/cust36a",
        "S3": "Newly S3 keys added for User.",
        "podData": {
            "services": "vod_pod, vod_service",
            "status": "success, success",
            "httpcode": "201, 201"
        }
    }
}

VOD Applications Listing

Endpoint: GET /api/application/vod

Description:

This API endpoint returns a list of VOD Application objects associated with a user, based on the given parameters, or an empty result set.

Parameters:

Name Located in Description Required Type
Authorization Header Bearer token received after authentication Yes String
location Query The desired location for the application. Yes String
filter Query List filter. Mandatory Filters: userid, location. Additional filtering by the following fields is possible: status, name No Hash
order Query List order. Ordering by the following fields is possible: appid, userid, name, active, security_template (asc or desc). Example: name.asc or appid.desc No String
offset Query Result-set offset, used in pagination. Default = 0 No Integer
limit Query Result-set records count. Default = 10 No Integer

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error
message String Human-readable result message
meta Object Meta data object of the result returned, including filter parameters, order, offset, limit, count of results in the set and total results
data Array A list of VOD Application objects or a message if no application found

Response codes:

Code Name Description
200 Success The applications list is retrieved
204 No results The applied filters produce an empty result-set
400 Bad request Invalid request parameters

Example Request:

To get all applications associated with user ID 13 and location 'sof', ordered by name in ascending order, you can use:

curl http://dev.k.cdn.bg/api/application/vod/ -G \
    -H "Authorization: Bearer <your_token>" \
    -d 'filter[userid]=13' \
    -d 'filter[location]=sof' \
    -d 'order=name.asc'

Example Response:

{
    "result": 200,
    "message": "Success",
    "meta": {
        "filter": {
            "userid": 13,
            "location": "sof"
        },
        "order": "appid.desc",
        "offset": 0,
        "limit": 5,
        "count": 2,
        "total": 2
    },
    "data": [
        {
            "appid": 10008,
            "userid": 13,
            "name": "Real-Vod-01",
            "security_template": 0,
            "active": 1,
            "source_s3_cred_id": 1,
            "dest_s3_cred_id": 2,
            "customer_webhook": null
        },
        {
            "appid": 10007,
            "userid": 13,
            "name": "News",
            "security_template": 0,
            "active": 5,
            "source_s3_cred_id": 1,
            "dest_s3_cred_id": 2,
            "customer_webhook": "http:\/\/dev.k.cdn.bg\/test\/webhook\/index.php?cust10007"
        }
    ]
}

Updating VOD Application Parameters

Endpoint PATCH /api/application/vod/{appid}

This endpoint allows you to update parameters of an existing application. You will need to provide the user's ID, the location of the application, and the application ID.

Note: Application update is not cascading.

Parameters

Name Located in Description Required Type
Authorization Header Bearer token received after authentication. Yes String
userid Body & URL ID of the user. Yes Integer
appid Body ID of the application. This is a required field Yes String
name Body Name of the application. This is a required field Yes String
location Body The desired location for the application. Yes String
active Body The active status of the application. For user role, can only be 0 or 1. For admin role, can be any integer from 0 to 9 Yes Integer
security_template Body The security template ID. Must belong to the user and exist in the database Yes Integer
webhook Body Webhook to receive notification about processing of files. No String

Active parameter

Parameter Type Description User Admin Reseller Support
0 Integer Disable x x x x
1 Integer Enable x x x x
2 Integer Prohibited - x - -
3 Integer Reserved - x - -
4 Integer Suspend - Disable - x - -
5 Integer Suspend - Enable - x - -
6 Integer Reserved - x - -
7 Integer Reserved - x - -
8 Integer Reserved - x - -
9 Integer Deleted - x - -

Admins Only : If status of user is changed to anything else than Active (1), all his applications goes Suspended with status 4(Previously Disabled) or 5 (Previously Enabled). When status of user is changed again to Active (1), all previously suspended applications, goes in their reagular state. 4 -> Disabled, 5 -> Enabled.

Output data

Parameter Type Description
result Integer Result code of the operation
message String Details about the result of the operation
data JSON Object Contains the updated application data

Response codes

Code Name Description
200 Success The application is updated successfully!
400 Bad request There were errors during the process or one of the parameters is missing, empty, or invalid
401 Unauthorized Incorrect token or no permissions

Example Request

curl http://dev.k.cdn.bg/api/application/vod/10017 -X PATCH \
    -H "Authorization: Bearer <your_token>" \
            -d '{"userid": 13, "location": "sof", "name": "Movies-VoD", "appid": 10017, "active": 1 , "security_template": 0 , "webhook" : "http://example.com/webhook" , "dest_s3_cred_id" : "2", "source_s3_cred_id" : "1"}'

Example Response:

Change status to ENABLE

{
    "result": 200,
    "message": "Application updated successfully.",
    "data": {
        "appid": 10017,
        "userid": 13,
        "name": "Movies-VoD",
        "security_template": 0,
        "active": 1,
        "source_s3_cred_id": 1,
        "dest_s3_cred_id": 2,
        "customer_webhook": "http:\/\/example.com\/webhook"
    },
    "pod": {
        "services": "vod_pod, vod_service",
        "status": "success, success",
        "httpcode": "201, 201"
    }
}

or

Change status to DISABLE

{
    "result": 200,
    "message": "Application updated successfully.",
    "data": {
        "appid": 10017,
        "userid": 13,
        "name": "Movies-VoD",
        "security_template": 0,
        "active": 0,
        "source_s3_cred_id": 1,
        "dest_s3_cred_id": 2,
        "customer_webhook": "http:\/\/example.com\/webhook"
    },
    "pod": {
        "result": 200,
        "message": "App disabled successfully."
    }
}

or

Status not changed

{
    "result": 200,
    "message": "Application updated successfully.",
    "data": {
        "appid": 10017,
        "userid": 13,
        "name": "Movies-VoD",
        "security_template": 0,
        "active": 1,
        "source_s3_cred_id": 1,
        "dest_s3_cred_id": 2,
        "customer_webhook": "http:\/\/example.com\/webhook"
    },
    "pod": "Preserve current status!"
}

or

{
    "result": 400,
    "message": "Invalid Active value. Users can not change active value. Administratively prohibited."
}

or

{
    "result": 400,
    "message": "The security template does not belong to the user."
}

Deleting VOD Application

Endpoint DELETE /api/application/vod/{appid}

This endpoint allows you to delete an existing application. You will need to provide the user's ID, the location of the application, and the application ID.

Note: Application deletion is not cascading.

Parameters

Name Located in Description Required Type
Authorization Header Bearer token received after authentication. Yes String
userid Body & URL ID of the user. Yes Integer
appid Body ID of the application. This is a required field Yes String
location Body The desired location for the application. Yes String

Output data

Parameter Type Description
result Integer Result code of the operation
message String Details about the result of the operation

Response codes

Code Name Description
200 Success The application is deleted successfully!
400 Bad request There were errors during the process or one of the parameters is missing or empty
401 Unauthorized Incorrect token or no permissions

Example Request

curl http://dev.k.cdn.bg/api/application/vod/10066 -X DELETE \
    -H "Authorization: Bearer <your_token>" \
    -d '{"userid": 13, "location": "sof","appid": 10066}'

Example Response:

{
    "result": 200,
    "message": "App deleted successfully."
}

or

{
    "result": 400,
    "message": "Errors occurred: \nPod: An error occurred while deleting the Pod 'vod10066'. HTTP Status Code: 404\nService: An error occurred while deleting the Service 's-vod10066'. HTTP Status Code: 404\n"
}

Browse

List Objects / Browse across dir/file structure functionality

GET /api/vod/browse

This endpoint returns a combined list of directories and files associated with a given userid, appid, and parent. Directories are prioritized first before files. If the count of directories is less than the set limit, files fill up the remaining slots up to the limit.

This endpoint follows the same pattern as /file and /directory endpoints but unifies their functionalities. It provides a clean and intuitive way for users to retrieve a combined list of directories and files.

Parameters

Name Type Description
Authorization Header String Bearer token received after authentication
filter Hash List filter. Mandatory Filters : userid, appid, parent, location. Filtering by the following fields is also possible: status
limit Integer Maximum number of objects to return. Default is 10 , maximum is 100.
order Hash The field and direction to sort the list by, separated by a dot (.). For example, created.asc. Possible values : name, created, updated (asc or desc)

Output data

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error.
message String Human-readable result message.
meta Object Metadata about the request, including filter, order, limit, count (number of objects returned), and total (number of objects matching the filter).
data Hash An array of objects, each represented as an object with properties. Each object is either a directory or a file.

Response codes:

Code Name Description
200 Success The list was retrieved successfully
204 No Results No matching objects were found
400 Error If an error occurs, the API returns a JSON object with result set to 400 and message set to an error message.

Example Request

curl http://dev.k.cdn.bg/api/vod/browse/ -G \
    -H "Authorization: Bearer <your_token>" \
    -d 'filter[userid]=13' \
    -d 'filter[appid]=10006' \
    -d 'filter[parent]=0' \
    -d 'filter[location]=sof' \
    -d 'limit=10' \
    -d 'offset=20' \
    -d 'order=created.asc'

Example Response

{
    "result": 200,
    "message": "Success",
    "meta": {
        "filter": {
            "userid": 13,
            "appid": 10006,
            "parent": "6489b32d464636a62d0021cd"
        },
        "order": "path.asc",
        "limit": 10,
        "count": 3
    },
    "data": [
        {
            "Id": "6489b37913b2847ee80f4eb7",
            "name": "VeryFunny",
            "type": "directory",
            "parentId": "6489b32d464636a62d0021cd",
            "userid": 13,
            "appid": 10006,
            "created": "2023-06-14T12:32:57+0000",
            "updated": "2023-06-14T12:32:57+0000"
        },
        {
            "Id": "6492c8d6b95119fb7792a881",
            "filename": "Filename1.mp4",
            "type": "file",
            "parentId": "6489b32d464636a62d0021cd",
            "userid": 13,
            "appid": 10006,
            "url": "\/kcdn-13\/vod10006\/upload\/music\/trans\/Comedy\/Filename1.mp4",
            "status": "new",
            "contenttype": null,
            "filesize": null,
            "created": "2023-06-21T09:54:30+0000",
            "updated": "2023-06-21T10:03:20+0000"
        },
        {
            "Id": "6492c8d6b95119fb7792a886",
            "filename": "Filename2.mp4",
            "type": "file",
            "parentId": "6489b32d464636a62d0021cd",
            "userid": 13,
            "appid": 10006,
            "url": "\/kcdn-13\/vod10006\/upload\/music\/trans\/Comedy\/Filename2.mp4",
            "status": "new",
            "contenttype": null,
            "filesize": null,
            "created": "2023-06-21T09:54:30+0000",
            "updated": "2023-06-21T10:03:20+0000"
        }
    ]
}

Create a directory

POST /api/vod/directory

This endpoint adds a branch to the site's structure. To create a directory, it is necessary to supply its name and its location through path and parentid parameters, respectively.

Parameters

Name Type Description
Authorization Header String Bearer token received after authentication
userid Integer ID of the user. This is a required field
appid Integer ID of the application. This is a required field
Location String POP location
path String Path of the section. This is a required field
parentid Integer The ID of the parent section. If not selected, the default is 0

Output data

Parameter Type Description
Id Integer The internal identifier of the directory

Response codes

Code Name Description
200 Success The section is created!
400 Bad request One of the parameters is missing or empty
401 Unauthorized Incorrect username or password
500 Internal error The section cannot be created due to an error in the server

Example Request

curl http://dev.k.cdn.bg/api/vod/directory/ -X POST \
    -H "Authorization: Bearer <your_token>" \
	-d '{"userid": 13, "appid": 10006, "location": "sof", "path": "Test_section", "parentid":"12"}'

Example Response

{
    "result": 200,
    "message": "The section is created",
    "data": {
        "Id": "6489b2c7464636a62d0021cc"
    }
}

Directory Listing

GET /api/vod/directory

Description:

This API endpoint returns a list of Directory objects based on the given parameters, or an empty result set.

Parameters:

Name Type Description
Authorization Header String Bearer token received after authentication
filter Hash List filter. Mandatory Filters : userid, appid, location. Filtering by the following fields is possible: parent
order Hash List order. Ordering by the following fields is possible: path, created, updated (asc or desc) ex. path.desc or created.asc
offset Integer Result-set offset, used in pagination. Default = 0
limit Integer Result-set records count. Default = 100
fields Array The list of additional fields to include in the result-set. Available fields: url - the URL of the directory
expand Array The list of additional objects to include in the result-set. Available expands: children - the list of child directories

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error
message String Human-readable result message
meta Object Meta data object of the result returned
data Hash A list of Directory objects. The key of the Hash is the ID of the directory

Response codes:

Code Name Description
200 Success The directory list is retrieved
204 No results The applied filters produce an empty result-set

Example Request:

To get all directories with parent ID = 3, ordered by path in ascending order, you can use:

curl http://dev.k.cdn.bg/api/vod/directory/ -G \
    -H "Authorization: Bearer <your_token>" \
	-d 'filter[userid]=13' \
    -d 'filter[appid]=10006' \
    -d 'filter[location]=sof' \
	-d 'order=path.asc'

Example Response:

{
    "result": 200,
    "message": "Success",
    "meta": {
        "filter": {
            "userid": 13,
            "appid": 10006,
            "location": "sof"
        },
        "order": "path.asc",
        "offset": 0,
        "limit": 100,
        "count": 6,
        "total": 6
    },
    "data": {
        "64898203b0d08b2d16282854": {
            "Id": "64898203b0d08b2d16282854",
            "name": "dnes",
            "parentId": "64896e7cb0d08b2d16282852"
        },
        "648988cab0d08b2d1628285a": {
            "Id": "648988cab0d08b2d1628285a",
            "name": "hiphop",
            "parentId": "64898885b0d08b2d16282856"
        },
        "6489888fb0d08b2d16282858": {
            "Id": "6489888fb0d08b2d16282858",
            "name": "movies",
            "parentId": "0"
        },
        "64898885b0d08b2d16282856": {
            "Id": "64898885b0d08b2d16282856",
            "name": "music",
            "parentId": "0"
        },
        "64896e7cb0d08b2d16282852": {
            "Id": "64896e7cb0d08b2d16282852",
            "name": "sport",
            "parentId": "0"
        },
        "648988d2b0d08b2d1628285c": {
            "Id": "648988d2b0d08b2d1628285c",
            "name": "trans",
            "parentId": "64898885b0d08b2d16282856"
        }
    }
}

Files

Create/Add File

POST /api/vod/file

This endpoint processes the newly uploaded or updated files. When file is uploaded to S3 storage POST request need to be send to endpoint to add file in CDN structure. It also performs several tasks such as checking if the file exists in the S3 storage, getting the metadata about the file (such as size and content type), and creating or updating the file record in the CDN database.

Parameters

Name Located in Description Required Type
Authorization Header Bearer token received after authentication. Yes String
appid String ID of the application. Yes Integer
location String The desired location for the application. Yes String
dirid String 24-character hexadecimal string of the destination directory ID. Yes String
filename String Filename of the desired file which will be uploaded. Valid characters are a-z (case-insensitive), 0-9, "-", and "_". Only .mp4 are accepted at this time. Yes String

Output data

Parameter Type Description
result Integer The HTTP status code of the request
message String Informational message
data Object An object containing information about the file. This object includes: 'id' - The internal identifier of the file in MongoDB, 'userid' - The user ID extracted from the filename, 'appid' - The application ID extracted from the filename, 'url' - The filename (i.e., full path to the file on S3), 'filename' - The base name of the file, QueueID - ID of queue process that can be user from client to check what the actual state of file - queue, transcoding or transcoded.

Response codes

Code Name Description
201 Success The file was created or updated successfully
404 Not found The file was not found either in the S3 storage or the specified directory does not exist
500 Internal Server Error There was an error in processing the request, could be due to inability to access S3 or MongoDB operations

Example Request

curl http://dev.k.cdn.bg/api/vod/file/ -X POST \
    -H "Authorization: Bearer <your_token>" \
	-d '{"filename": "file.mp4", "appid": "10006", "dirid": "6489b32d464636a62d0021cD", "location": "sof"}'

Example Response

[
    {
        "result": 201,
        "message": "File created",
        "data": {
            "id": "6492c8d6b95119fb7792a881",
            "userid": 13,
            "appid": 10006,
            "url": "/kcdn-13/vod10006/upload/music/hiphop/file.mp4",
            "filename": "file.mp4",
            "QueueID": "64ba1eed07b50a72380e5e69"
        }
    }
]

Listing Files

GET /api/vod/file

This document provides details on how to use a provided PHP script to list files, stored in a CDN database.

API Endpoint

The script creates an API endpoint that accepts HTTP GET requests. The endpoint URL depends on where you deploy this script.

Parameters:

Name Type Description
Authorization Header String Bearer token received after authentication
filter Hash List filter. Mandatory Filters : userid, appid, location. Filtering by the following fields is possible: parent, status
order Hash The field and direction to sort the list by, separated by a dot (.). For example, path.asc.Possible values : path, created, updated (asc or desc)
offset Integer Number of files to skip before starting to collect the file list. Default is 0.
limit Integer Maximum number of files to return. Default is 100.
fields Array Comma-separated list of additional fields to include in the response. Can include url.
expand Array Not used in this script.

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error.
message String Human-readable result message.
meta Object Metadata about the request, including filter, order, offset, limit, count (number of files returned), and total (number of files matching the filter).
data Hash An array of files, each represented as an object with properties including Id, filename, status, parentId, filesize, contenttype, created, updated, and possibly url.

Response codes:

Code Name Description
200 Success The directory list is retrieved
204 No results The applied filters produce an empty result-set
400 Error If an error occurs, the API returns a JSON object with result set to 400 and message set to an error message.

Example Request

curl http://dev.k.cdn.bg/api/vod/file/ -G \
        -H "Authorization: Bearer <your_token>" \
        -d 'filter[userid]=13' \
        -d 'filter[appid]=10006' \
        -d 'filter[location]=sof' \
        -d 'order=path.asc' \
        -d 'filter[parent]=0'

Example Responce

{
    "result": 200,
    "message": "Success",
    "meta": {
        "filter": {
            "userid": 13,
            "appid": 10006,
            "location": "sof"
        },
        "order": "path.asc",
        "offset": 0,
        "limit": 100,
        "count": 5,
        "total": 5
    },
    "data": {
        "6492c8d6b95119fb7792a87c": {
            "Id": "6492c8d6b95119fb7792a87c",
            "filename": "Filename1.mp4",
            "status": "new",
            "parentId": "648988d2b0d08b2d1628285c",
            "filesize": null,
            "contenttype": null,
            "created": "2023-06-21T09:54:30+0000",
            "updated": "2023-06-21T09:59:08+0000"
        },
        "6492c8d6b95119fb7792a881": {
            "Id": "6492c8d6b95119fb7792a881",
            "filename": "Filename1.mp4",
            "status": "new",
            "parentId": "6489b32d464636a62d0021cd",
            "filesize": null,
            "contenttype": null,
            "created": "2023-06-21T09:54:30+0000",
            "updated": "2023-06-21T10:03:20+0000"
        },
        "6492c8d6b95119fb7792a888": {
            "Id": "6492c8d6b95119fb7792a888",
            "filename": "sport.mp4",
            "status": "new",
            "parentId": "0",
            "filesize": null,
            "contenttype": null,
            "created": "2023-06-21T09:54:30+0000",
            "updated": "2023-06-21T10:03:20+0000"
        },
    }
}

Create Security Template (url)

ENDPOINT : POST /api/security/template/

This document provides details on how to use a provided PHP script to create valid security template.

API Endpoint

The script creates an API endpoint that accepts HTTP POST requests. To create security template that user can assign to specific Application or Object frontend must send paramteres using POST request and send data in JSON format. The security of content is complex mechanism and in the same time very flexible. The client can select only these or all security restriction that match his criteria. If there is a value in one of the criteria, this criteria will be applied automaticaly to security template. Example if client want to secure his content only by Viewer_IP, and User-Agent, client can select only verify_ip,verify_user_agent with True. If client want to made some complicated security, he can add country restriction, or even time limits when, the content will be displayed using country_whitelist,country_blacklist and valid_after,valid_before. Any combination betwen : verify_ip,verify_user_agent,country_whitelist,country_blacklist,valid_after,valid_before,whitelist_net,blacklist_net and referrer is possible. One, two or all parameters can be used when client design his own security criteria.

Parameters:

Name Located in Description Required Type
Authorization Header Header Bearer token received after authentication. Yes String
location URL Location. Yes String
type URL Type of selected stream - main , object and etc. Yes String
template_name URL Human readable name of template. Yes String
referrer URL Referrer domain or subdomain that stream can be published. No Array
verify_ip URL Secure content using remote client IP address. True/Flase No Bool
verify_user_agent URL Secure content using remote client User-Agent including OS, Browser, Versions and etc. True/Flase No Bool
valid_after URL Time after template is gain access to content in format UNIX TimeStamp. No Integer
valid_before URL Time before template is gain access to content in format UNIX TimeStamp. No Integer
whitelist_net URL White List of IP address or networks that has access to content. No Array
blacklist_net URL Black List of IP address or networks that has NO access to content. No Array
country_whitelist URL White list of country/s with they two letters code that has access to content. No Array
country_blacklist URL Black list of country/s with they two letters code that has NO access to content. No Array

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error.
message String Human-readable result message.
data JsonData Detailed output of template content.

Response codes:

Code Name Description
200 Success The directory list is retrieved
204 No results The applied filters produce an empty result-set
400 Error If an error occurs, the API returns a JSON object with result set to 400 and message set to an error message.

Example Request

curl -X POST http://dev.k.cdn.bg/api/security/template/ \
        -H "Authorization: Bearer <your_token>" \
        -H "Content-Type: application/json" \
        -d '{
            "location": "sof",
            "type": "main",
            "template_name": "First_Template_Name",
            "userid": 13,
            "valid_after": 1572504800,
            "valid_before": 1794040800,
            "verify_ip": true,
            "verify_user_agent": false,
            "referrer": ["domain.com", "cdn-k.*", "*.cdn.bg", "*.k.cdn.bg" , "k.cdn.*"],
            "whitelist_net": ["192.168.1.24", "174.34.55.98", "89.10.11.12/27" , "4.4.4.4/32" , "123.45.67.0/24"],
            "blacklist_net": ["10.0.0.0/8"],
            "country_whitelist": ["US", "CA", "BG", "DE", "IT", "UA"],
            "country_blacklist": ["RU", "TR"]
         }'

Example Response

{
    "result": 201,
    "message": "Success",
    "data": {
        "template": {
            "created": "2023-09-08T11:03:04+0000",
            "updated": "2023-09-08T11:03:04+0000",
            "location": "sof",
            "userid": 13,
            "name": "First_Template_Name",
            "type": "main",
            "verify_ip": true,
            "verify_user_agent": false
        },
        "timerange": {
            "valid_after": "2019-10-31T06:53:20+0000",
            "valid_before": "2026-11-07T08:40:00+0000"
        },
        "referrer": {
            "domains": [
                "domain.com",
                "cdn-k.*",
                "*.cdn.bg",
                "*.k.cdn.bg",
                "k.cdn.*"
            ]
        },
        "whitelist": {
            "nets": [
                "192.168.1.24",
                "174.34.55.98",
                "89.10.11.12\/27",
                "4.4.4.4\/32",
                "123.45.67.0/24"
            ]
        },
        "blacklist": {
            "nets": [
                "10.0.0.0\/8"
            ]
        },
        "country_whitelist": {
            "codes": [
                "US",
                "CA",
                "BG",
                "DE",
                "IT",
                "UA"
            ]
        },
        "country_blacklist": {
            "codes": [
                "RU",
                "TR"
            ]
        }
    }
}

Edit Security Template (url)

ENDPOINT : PATCH /api/security/template/{user_id}

This document provides details on how to use a provided PHP script to edit security template.

API Endpoint

The script creates an API endpoint that accepts HTTP PATCH requests. To edit security template that user can assign to specific Application or Object frontend must send paramteres using PATCH request and send data in JSON format. Security Template ID (stid) is mandatory to edit epcific template. The security of content is complex mechanism and in the same time very flexible. The client can select only these or all security restriction that match his criteria. If there is a value in one of the criteria, this criteria will be applied automaticaly to security template. Example if client want to secure his content only by Viewer_IP, and User-Agent, client can select only verify_ip,verify_user_agent with True. If client want to made some complicated security, he can add country restriction, or even time limits when, the content will be displayed using country_whitelist,country_blacklist and valid_after,valid_before. Any combination betwen : verify_ip,verify_user_agent,country_whitelist,country_blacklist,valid_after,valid_before,whitelist_net,blacklist_net and referrer is possible. One, two or all parameters can be used when client design his own security criteria.

NOTE: All parameters will be overwriten with new ones!

Parameters:

Name Located in Description Required Type
Authorization Header Header Bearer token received after authentication. Yes String
location URL Location. Yes String
stid Body Security Template ID Yes String
type Body Type of selected stream - main , object and etc. Yes String
template_name Body Human readable name of template. Yes String
referrer Body Referrer domain or subdomain that stream can be published. No Array
verify_ip Body Secure content using remote client IP address. True/Flase No Bool
verify_user_agent Body Secure content using remote client User-Agent including OS, Browser, Versions and etc. True/Flase No Bool
valid_after Body Time after template is gain access to content in format UNIX TimeStamp. No Integer
valid_before Body Time before template is gain access to content in format UNIX TimeStamp. No Integer
whitelist_net Body White List of IP address or networks that has access to content. No Array
blacklist_net Body Black List of IP address or networks that has NO access to content. No Array
country_whitelist Body White list of country/s with they two letters code that has access to content. No Array
country_blacklist Body Black list of country/s with they two letters code that has NO access to content. No Array

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error.
message String Human-readable result message.
data JsonData Detailed output of template content.

Response codes:

Code Name Description
200 Success The directory list is retrieved
204 No results The applied filters produce an empty result-set
400 Error If an error occurs, the API returns a JSON object with result set to 400 and message set to an error message.

Example Request

curl -X PATCH http://dev.k.cdn.bg/api/security/template/ \
         -H "Authorization: Bearer <your_token>" \
         -H "Content-Type: application/json" \
         -d '{
            "stid": "64faff68f0b3432f030b30c4",
            "location": "sof",
            "type": "main",
            "template_name": "Edit_First_Template_name_9",
            "userid": 13,
            "valid_after": 1572504800,
            "valid_before": 1794040800,
            "verify_ip": true,
            "verify_user_agent": false,
            "referrer": ["ed.domain.com", "ed.cdn-k.*", "*.cdn.bg", "*.k.cdn.bg" , "k.cdn.*"],
            "whitelist_net": ["192.168.99.24", "174.99.55.98", "89.10.11.12/27" , "4.4.4.4/32", "0.0.0.0/0", "0.0.0.0/16"],
            "blacklist_net": ["10.0.0.0/8", "10.0.99.0"],
            "country_whitelist": ["US", "CA", "BG", "DE", "IT", "UA", "RO"],
            "country_blacklist": ["RU", "TR", "NI"]
         }'

Example Response

{
    "result": 201,
    "message": "Success",
    "data": {
        "template": {
            "updated": "2023-09-12T10:29:21+0000",
            "location": "sof",
            "userid": 13,
            "name": "Edit_First_Template_name_9",
            "type": "main",
            "verify_ip": true,
            "verify_user_agent": false,
            "stid": "64faff68f0b3432f030b30c4"
        },
        "timerange": {
            "valid_after": "2019-10-31T06:53:20+0000",
            "valid_before": "2026-11-07T08:40:00+0000"
        },
        "referrer": {
            "domains": [
                "ed.domain.com",
                "ed.cdn-k.*",
                "*.cdn.bg",
                "*.k.cdn.bg",
                "k.cdn.*"
            ]
        },
        "whitelist": {
            "nets": [
                "192.168.99.24",
                "174.99.55.98",
                "89.10.11.12\/27",
                "4.4.4.4\/32",
                "0.0.0.0\/0",
                "0.0.0.0\/16"
            ]
        },
        "blacklist": {
            "nets": [
                "10.0.0.0\/8",
                "10.0.99.0"
            ]
        },
        "country_whitelist": {
            "codes": [
                "US",
                "CA",
                "BG",
                "DE",
                "IT",
                "UA",
                "RO"
            ]
        },
        "country_blacklist": {
            "codes": [
                "RU",
                "TR",
                "NI"
            ]
        }
    }
}

List Security Templates (or Get Full Info)

ENDPOINT : GET /api/security/template/

This document provides details on how to use a provided PHP script to list live streams, stored in a CDN database. Or get full Info for stream.

API Endpoint

The script creates an API endpoint that accepts HTTP GET requests. The endpoint URL depends on where you deploy this script. To get full info for stream including hish HASH, that is used to authenticate to streaming servers to initilize streams, you need to use as a request for filter filed streamid.

Parameters:

Name Type Description
Authorization Header String Bearer token received after authentication
filter Hash List filter. Mandatory Filters : userid, location, stid or name to get full information is mandatory to use stid. Filtering by the following fields is possible: name, streamname, status, streamid
order Hash The field and direction to sort the list by, separated by a dot (.). For example, name.asc.Possible values : name, stid, created, updated (asc or desc)
offset Integer Number of live streams to skip before starting to collect the stream list. Default is 0.
limit Integer Maximum number of stream to return. Default is 100.
fields Array Comma-separated list of additional fields to include in the response. Can include url.
expand Array Not used in this script.

Output data:

Parameter Type Description
result Integer Result code. 200 for successful operation or status code for error.
message String Human-readable result message.
meta Object Metadata about the request, including filter, order, offset, limit, count (number of files returned), and total (number of files matching the filter).
data Hash An array of files, each represented as an object with properties including stid, template_name, created, updated and all data that is asociated with template.

Response codes:

Code Name Description
200 Success The directory list is retrieved
204 No results The applied filters produce an empty result-set
400 Error If an error occurs, the API returns a JSON object with result set to 400 and message set to an error message.

Example Request (List)

curl http://dev.k.cdn.bg/api/security/template/ -G \
    -H "Authorization: Bearer <your_token>" \
    -d "filter[location]=sof" \
    -d "order=name.asc" \
    -d "limit=3"

Example Response (List)

{
    "result": 201,
    "message": "Success",
    "meta": {
        "filter": {
            "location": "sof",
            "userid": 13
        },
        "order": "template.name.asc",
        "offset": 0,
        "limit": 3,
        "count": 7,
        "total": 5
    },
    "data": {
        "64faff68f0b3432f030b30c4": {
            "template": {
                "updated": "2023-09-12T10:38:47+0000",
                "location": "sof",
                "userid": 13,
                "name": "Edit_First_Template_name_9",
                "type": "main",
                "verify_ip": true,
                "verify_user_agent": false
            },
            "timerange": {
                "valid_after": "2019-10-31T06:53:20+0000",
                "valid_before": "2026-11-07T08:40:00+0000"
            },
            "referrer": {
                "domains": [
                    "ed.domain.com",
                    "ed.cdn-k.*",
                    "*.cdn.bg",
                    "*.k.cdn.bg",
                    "k.cdn.*"
                ]
            },
            "whitelist": {
                "nets": [
                    "192.168.99.24",
                    "174.99.55.98",
                    "89.10.11.12\/27",
                    "4.4.4.4\/32",
                    "0.0.0.0\/0",
                    "0.0.0.0\/16"
                ]
            },
            "blacklist": {
                "nets": [
                    "10.0.0.0\/8",
                    "10.0.99.0"
                ]
            },
            "country_whitelist": {
                "codes": [
                    "US",
                    "CA",
                    "BG",
                    "DE",
                    "IT",
                    "UA",
                    "RO"
                ]
            },
            "country_blacklist": {
                "codes": [
                    "RU",
                    "TR",
                    "NI"
                ]
            }
        },
        "64fad5f1f30225aeea0b1d68": {
            "template": {
                "created": "2023-09-08T08:06:09+0000",
                "updated": "2023-09-08T08:06:09+0000",
                "location": "sof",
                "userid": 13,
                "name": "First_Template_name_1",
                "type": "main",
                "verify_ip": true,
                "verify_user_agent": true
            },
            "timerange": {
                "valid_after": "2019-10-31T06:53:20+0000",
                "valid_before": "2026-11-07T08:40:00+0000"
            },
            "referrer": {
                "domains": [
                    "domain.com",
                    "cdn.*",
                    "*.cdn.bg",
                    "*.k.cdn.bg",
                    "k.cdn.*"
                ]
            },
            "whitelist": {
                "nets": [
                    "192.168.1.0\/24",
                    "174.34.55.98",
                    "8.8.8.8",
                    "4.4.4.4",
                    "4.0.0.0\/8",
                    "0.0.0.0\/16"
                ]
            },
            "blacklist": {
                "nets": [
                    "10.0.0.0\/8"
                ]
            },
            "country_whitelist": {
                "codes": [
                    "US",
                    "CA",
                    "BG",
                    "DE",
                    "IT",
                    "UA"
                ]
            },
            "country_blacklist": {
                "codes": [
                    "RU",
                    "TR"
                ]
            }
        },
        "64fad9dbf0b3432f030b30c3": {
            "template": {
                "created": "2023-09-08T08:22:51+0000",
                "updated": "2023-09-08T08:22:51+0000",
                "location": "sof",
                "userid": 13,
                "name": "First_Template_name_2",
                "type": "main",
                "verify_ip": true,
                "verify_user_agent": false
            },
            "timerange": {
                "valid_after": "2019-10-31T06:53:20+0000",
                "valid_before": "2026-11-07T08:40:00+0000"
            },
            "referrer": {
                "domains": [
                    "domain.com",
                    "cdn-k.*",
                    "*.cdn.bg",
                    "*.k.cdn.bg",
                    "k.cdn.*"
                ]
            },
            "whitelist": {
                "nets": [
                    "192.168.1.24",
                    "174.34.55.98",
                    "89.10.11.12\/27",
                    "4.4.4.4\/32",
                    "0.0.0.0\/0",
                    "0.0.0.0\/16"
                ]
            },
            "blacklist": {
                "nets": [
                    "10.0.0.0\/8"
                ]
            },
            "country_whitelist": {
                "codes": [
                    "US",
                    "CA",
                    "BG",
                    "DE",
                    "IT",
                    "UA"
                ]
            },
            "country_blacklist": {
                "codes": [
                    "RU",
                    "TR"
                ]
            }
        }
    }
}

Example Request (Get info for specific Security Template ID (stid))

http://dev.k.cdn.bg/api/security/template/ -G \
    -H "Authorization: Bearer <your_token>" \
    -d "filter[location]=sof" \
    -d "filter[stid]=65000a4e6d21af897f017468"

Example Response (Get info for specific Security Template ID (stid))

{
    "result": 201,
    "message": "Success",
    "meta": {
        "filter": {
            "location": "sof",
            "stid": "65000a4e6d21af897f017468",
            "userid": 13
        },
        "order": "template.name.asc",
        "offset": 0,
        "limit": 3,
        "count": 7,
        "total": 1
    },
    "data": {
        "65000a4e6d21af897f017468": {
            "template": {
                "created": "2023-09-12T06:50:54+0000",
                "updated": "2023-09-12T06:50:54+0000",
                "location": "sof",
                "userid": 13,
                "name": "First_Template_name_STID",
                "type": "main",
                "verify_ip": true,
                "verify_user_agent": false
            },
            "timerange": {
                "valid_after": "2019-10-31T06:53:20+0000",
                "valid_before": "2026-11-07T08:40:00+0000"
            },
            "referrer": {
                "domains": [
                    "domain.com",
                    "cdn-k.*",
                    "*.cdn.bg",
                    "*.k.cdn.bg",
                    "k.cdn.*"
                ]
            },
            "whitelist": {
                "nets": [
                    "192.168.1.24",
                    "174.34.55.98",
                    "89.10.11.12\/27",
                    "4.4.4.4\/32",
                    "0.0.0.0\/0",
                    "0.0.0.0\/16"
                ]
            },
            "blacklist": {
                "nets": [
                    "10.0.0.0\/8"
                ]
            },
            "country_whitelist": {
                "codes": [
                    "US",
                    "CA",
                    "BG",
                    "DE",
                    "IT",
                    "UA"
                ]
            },
            "country_blacklist": {
                "codes": [
                    "RU",
                    "TR"
                ]
            }
        }
    }
}

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors