Skip to content

General Settings

sadhasivam edited this page Sep 10, 2024 · 1 revision

Create or Update Common Setting

URL: /api/admin/common-setting

Method: POST

Description: Creates or updates a common setting.

Parameters

Parameter Type Required/Optional Description
google_site_key String Optional The public site key for Google v3 reCAPTCHA.
google_secret_key String Optional The secret key for Google v3 reCAPTCHA
g-recaptcha-response String Optional The response token from Google v3 reCAPTCHA.
recaptcha_status Integer Optional The status of reCAPTCHA (e.g., 1 for enabled, 0 for disabled).
agora_invoicing_url String Optional URL for Agora invoicing; must be a valid URL.
timezone Integer Optional Timezone identifier; must be an integer.
time_format Integer Optional Time format identifier; must be an integer.
date_format Integer Optional Date format identifier; must be an integer.
icon File Optional Image file for the icon; must be a PNG, JPG, JPEG, or GIF and no larger than 2 MB.
admin_logo File Optional Image file for the admin logo; must be a PNG, JPG, JPEG, or GIF and no larger than 2 MB.
client_logo File Optional Image file for the client logo; must be a PNG, JPG, JPEG, or GIF and no larger than 2 MB.
icon_default String Optional Indicates if the default icon should be used.
admin_logo_default String Optional Indicates if the default admin logo should be used.
client_logo_default String Optional Indicates if the default client logo should be used.

Response

{
    "success": true,
    "message": "Your General Settings for License Manager have saved successfully",
    "data": ""
}

Get Common Setting

URL: /api/admin/common-setting/get

Method: GET

Description: Retrieves the current common setting.

Parameters

This endpoint does not require any parameters.

Response

{
    "success": true,
    "data": {
        "google_site_key": "6LeNWgUqbnsddnExaPRd4hdOIOVMI9dJSJxESp16",
        "google_secret_key": "6LeNWgUqAghvvhvjddoo1WfwIPHBDXIpovmwEXdB",
        "agora_invoicing_url": "https:\/\/demo.admin\/\/public\/",
        "timezone": {
            "id": 1,
            "location": "(GMT+00:00) UTC",
            "name": "UTC"
        },
        "date_format": {
            "id": 13,
            "format": "F j, Y",
            "js_format": "LL",
            "is_active": 1
        },
        "time_format": {
            "id": 3,
            "format": "g:i a",
            "hours": "12 Hours",
            "js_format": "hh:mm a",
            "is_active": 1
        },
        "time_formaat": "2",
        "recaptcha_status": 1,
        "icon": "https:\/\/demp.admin\/manager\/public\/themes\/default\/img\/favicon.ico",
        "admin_logo": "https:\/\/demo.admin\/manager\/public\/themes\/default\/img\/logo.png",
        "client_logo": "https:\/\/demo.admin\/manager\/public\/themes\/default\/img\/default.png",
        "icon_default": "0",
        "admin_logo_default": "0",
        "client_logo_default": "0"
    }
}

Get Timezones

URL: /api/admin/timezones

Method: GET

Description: Retrieves a dropdown list of timezones.

Parameters

This endpoint does not require any parameters.

Response

{
    "success": true,
    "data": [
        {
            "id": 56,
            "location": "(GMT+02:00) Africa/Cairo",
            "name": "Africa/Cairo"
        },
        {
            "id": 31,
            "location": "(GMT) Africa/Casablanca",
            "name": "Africa/Casablanca"
        }
        // All timezones are shown here
    ]
}

Get Date Formats

URL: /api/admin/date-formats

Method: GET

Description: Retrieves a dropdown list of date formats.

Parameters

This endpoint does not require any parameters.

Response

{
    "success": true,
    "data": [
            {
                "id": 10,
                "format": "d-m-Y",
                "js_format": "DD-MM-YYYY",
                "is_active": 1
            },
            {
                "id": 11,
                "format": "m-d-Y",
                "js_format": "MM-DD-YYYY",
                "is_active": 1
            },
            {
                "id": 12,
                "format": "Y-m-d",
                "js_format": "YYYY-MM-DD",
                "is_active": 1
            },
            {
                "id": 13,
                "format": "F j, Y",
                "js_format": "LL",
                "is_active": 1
            }
        ],
}

Get Time Formats

URL: /api/admin/time-formats

Method: GET

Description: Retrieves a dropdown list of time formats.

Parameters

This endpoint does not require any parameters.

Response

{
    "success": true,
    "data": [
            {
                "id": 1,
                "format": "H:i:s",
                "hours": "24 Hours",
                "js_format": "HH:mm",
                "is_active": 1
            },
            {
                "id": 3,
                "format": "g:i a",
                "hours": "12 Hours",
                "js_format": "hh:mm a",
                "is_active": 1
            }
        ],
}

Clone this wiki locally