GMCheck LogoGMCheck

Tài Liệu API Key

Hướng dẫn đầy đủ về cách sử dụng GMCheck API với API keys

Tổng Quan

API Key cho phép người dùng premium truy cập API xác minh email mà không cần xác thực đăng nhập. Các endpoint API Key sử dụng tiền tố riêng /api/v1/ và không yêu cầu mã hóa.

Yêu Cầu

  • Chỉ Gói Premium: Tính năng API Key chỉ dành cho người dùng premium
  • Mỗi người dùng chỉ có thể có một API key
  • Các endpoint API key không sử dụng mã hóa (yêu cầu/phản hồi văn bản thuần)

Bắt Đầu

1. Tạo API Key

Đầu tiên, bạn cần tạo API key thông qua giao diện web:

  1. Đăng nhập vào tài khoản của bạn
  2. Nhấp vào menu hồ sơ của bạn
  3. Chọn "API Key" (chỉ hiển thị cho người dùng premium)
  4. Nhấp "Tạo API Key"
  5. Quan trọng: Sao chép và lưu API key của bạn ngay lập tức - bạn sẽ không thể xem nó lại!

⚠️ Cảnh báo: Bạn sẽ không thể xem API key của mình lại sau khi tạo. Vui lòng lưu nó một cách an toàn.

2. Sử Dụng API Key

API Key có thể được cung cấp theo ba cách:

  1. X-API-Key Header (Được khuyến nghị):
    X-API-Key: your-api-key-here
  2. Authorization Header:
    Authorization: Bearer your-api-key-here
  3. Query Parameter (Ít an toàn hơn):
    ?apiKey=your-api-key-here

API Endpoints

Tất cả các endpoint API key sử dụng tiền tố /api/v1/ và không yêu cầu mã hóa.

1. Kiểm Tra Email

Gửi một công việc để kiểm tra địa chỉ email.

Endpoint:

POST /api/v1/check-emails

Request:

{
  "input": "[email protected]\[email protected]\[email protected]"
}

Response:

{
  "success": true,
  "code": "JOB_SUBMITTED",
  "message": "Job submitted successfully",
  "data": {
    "jobId": "job-123-1234567890",
    "status": "pending",
    "emailsCount": 3
  }
}

2. Lấy Lịch Sử Công Việc

Lấy danh sách phân trang các công việc của bạn.

Endpoint:

GET /api/v1/jobs/history?page=1&limit=20

3. Lấy Thống Kê Công Việc

Lấy thống kê tóm tắt cho một công việc cụ thể.

Endpoint:

GET /api/v1/jobs/:jobId/stats

4. Lấy Chi Tiết Công Việc

Lấy chi tiết đầy đủ của công việc bao gồm tất cả kết quả.

Endpoint:

GET /api/v1/jobs/:jobId

5. Lấy Thống Kê Sử Dụng

Lấy thống kê sử dụng hiện tại của bạn.

Endpoint:

GET /api/v1/usage

Ví Dụ Mã

Ví Dụ cURL

# Check Gmail addresses
curl -X POST https://api.gmcheck.live/api/v1/check-emails \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"input": "[email protected]\[email protected]"}'

# Get job stats
curl -X GET https://api.gmcheck.live/api/v1/jobs/job-123-1234567890/stats \
  -H "X-API-Key: your-api-key-here"

Ví Dụ Python

import requests

API_KEY = "your-api-key-here"
BASE_URL = "https://api.gmcheck.live/api/v1"

headers = {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json"
}

# Check emails
response = requests.post(
    f"{BASE_URL}/check-emails",
    headers=headers,
    json={"input": "[email protected]\[email protected]"}
)
job_data = response.json()
job_id = job_data["data"]["jobId"]

# Get job stats
stats_response = requests.get(
    f"{BASE_URL}/jobs/{job_id}/stats",
    headers=headers
)
stats = stats_response.json()
print(stats)

Ví Dụ JavaScript

const API_KEY = "your-api-key-here";
const BASE_URL = "https://api.gmcheck.live/api/v1";

const headers = {
  "X-API-Key": API_KEY,
  "Content-Type": "application/json"
};

// Check Gmail addresses
const checkEmails = async () => {
  const response = await fetch(`${BASE_URL}/check-emails`, {
    method: "POST",
    headers: headers,
    body: JSON.stringify({
      input: "[email protected]\[email protected]"
    })
  });
  
  const data = await response.json();
  const jobId = data.data.jobId;
  
  // Poll for job completion
  const pollJob = async () => {
    const statsResponse = await fetch(`${BASE_URL}/jobs/${jobId}/stats`, {
      headers: headers
    });
    const stats = await statsResponse.json();
    
    if (stats.data.status === "completed") {
      // Get full results
      const detailResponse = await fetch(`${BASE_URL}/jobs/${jobId}`, {
        headers: headers
      });
      const detail = await detailResponse.json();
      console.log(detail.data.result);
    } else {
      // Poll again after delay
      setTimeout(pollJob, 2000);
    }
  };
  
  pollJob();
};

Giá Trị Trạng Thái Email

  • LIVE: Email hợp lệ và đang hoạt động
  • VERIFY: Email cần xác minh
  • DISABLE: Email bị vô hiệu hóa
  • NOT_EXIST: Email không tồn tại
  • UNKNOWN: Trạng thái không xác định
  • PENDING: Email vẫn đang được xử lý

Giá Trị Trạng Thái Công Việc

  • pending: Công việc đang trong hàng đợi và chờ được xử lý
  • processing: Công việc đang được xử lý
  • completed: Công việc đã hoàn thành thành công
  • stopped: Công việc đã bị dừng bởi người dùng
  • failed: Công việc không thể hoàn thành

Thực Hành Bảo Mật Tốt Nhất

  • Không bao giờ chia sẻ API key của bạn: Đối xử với API key như mật khẩu
  • Sử dụng biến môi trường: Lưu trữ API keys trong biến môi trường, không phải trong code
  • Xoay vòng thường xuyên: Tạo lại API key của bạn định kỳ
  • Thu hồi nếu bị xâm phạm: Nếu bạn nghi ngờ API key của mình bị xâm phạm, hãy thu hồi ngay lập tức
  • Chỉ sử dụng HTTPS: Luôn sử dụng HTTPS khi thực hiện yêu cầu API
  • Giám sát sử dụng: Thường xuyên kiểm tra thống kê sử dụng để phát hiện truy cập trái phép

Phản Hồi Lỗi

Invalid API Key:

{
  "success": false,
  "code": "INVALID_API_KEY",
  "message": "Invalid API key. Please check your API key and try again."
}

Premium Required:

{
  "success": false,
  "code": "PREMIUM_REQUIRED",
  "message": "API key feature is only available for premium users."
}

Monthly Limit Exceeded:

{
  "success": false,
  "code": "MONTHLY_LIMIT_EXCEEDED",
  "message": "Monthly limit exceeded. You have checked 100000 / 100000 emails this month."
}

Hỗ Trợ

Đối với các vấn đề hoặc câu hỏi liên quan đến API keys, vui lòng liên hệ hỗ trợ thông qua trang liên hệ hoặc Telegram.