Tài liệu API

Token

Để lấy API Key bạn cần Đăng nhập và truy cập Hồ sơ cá nhân.

Lưu ý: Mỗi tài khoản chỉ có 1 API Key duy nhất và không thể thay đổi. Vui lòng không chia sẻ API Key của mình với người khác.

Lấy số lượng tài khoản có thể kiểm tra mỗi lần.

URL:/api/emails/count

Method:POST

Content Type:application/x-www-form-urlencoded

Params:

Key	Type	Required	Method	Description
api_key	String	True	POST	API Key của bạn.

Example:

{
    "api_key": "your_api_key"
}

Response:

Key	Type	Required	Description
status	Boolean	True	Trả về true nếu thành công. Trả về false nếu xảy ra lỗi.
message	String	True	Nội dung thông báo.
data	Object	True	Dữ liệu trả về.
data.count	Int	False	Số lượng email tối đa có thể check mỗi lần.

Example:

{
    "status": true,
    "message": "Lấy dữ liệu thành công",
    "data": {
        "count": 3
    }
}

{
    "status": false,
    "message": "Không tìm thấy email kiểm tra",
    "data": []
}

Lấy thông tin tài khoản

URL:http://jacheckmail.xyz:8008/info

Method:POST

Content Type:application/x-www-form-urlencoded

Params:

Key	Type	Required	Method	Description
api_key	String	True	POST	API Key của bạn.

Example:

{
    "api_key": "your_api_key",
}

Response:

Key	Value	Required	Description
status	Boolean	True	Trả về true nếu thành công. Trả về false nếu xảy ra lỗi.
message	String	True	Nội dung thông báo.
data	Object	True	Dữ liệu trả về.
data.email	String	True	Email của tài khoản
data.count	String	True	Số lượng check còn lại.
data.expired_at	Integer	True	Hạn sử dụng lượt check.

Example:

{
    "data": [],
    "message": "API_KEY không hợp lệ",
    "status": false
}

{
    "data": {
        "count": 999999999,
        "email": "example@gmail.com",
        "expired_at": "2023-01-01 12:12:12"
    },
    "message": "Lấy thông tin thành công",
    "status": true
}

Kiểm tra email

URL:http://jacheckmail.xyz:8008/check

Method:POST

Content Type:application/x-www-form-urlencoded

Params:

Key

Type

Required

Method

Description

api_key

String

True

POST

API Key của bạn.

emails

Array

True

POST

Mảng chứa các email cần kiểm tra.

Trong đó:

email: Email cần kiểm tra.

index: Số thứ tự của email.

Example:

{
    "api_key": "your_api_key",
    "emails": [
            {
                "email": "example@gmail.com",
                "index": 1
            },
            {
                "email": "example2@gmail.com",
                "index": 2
            },
            {
                "email": "example3@gmail.com",
                "index": 3
            }
        ]
}

Response:

Key	Value	Required	Description
status	Boolean	True	Trả về true nếu thành công. Trả về false nếu xảy ra lỗi.
message	String	True	Nội dung thông báo.
data	Object	True	Dữ liệu trả về.
data.email	String	True	Email được kiểm tra.
data.status	String	True	Trạng thái email: live, die, verify_phone, not_exist, wrong_format, error.
data.index	Integer	True	Vị trí của email.

Example:

{
    "status": false,
    "message": "Email không hợp lệ: example@gmail.com",
    "data": []
}

{
    "status": true,
    "message": "Lấy dữ liệu thành công",
    "data": [
        {
            "email": "example@gmail.com",
            "status": "live",
            "index": 1
        },
        {
            "email": "example2@gmail.com",
            "status": "die",
            "index": 2
        },
        {
            "email": "example3@gmail.com",
            "status": "verify_phone",
            "index": 3
        },
        {
            "email": "example4@gmail.com",
            "status": "not_exist",
            "index": 4
        }
    ]
}