GMCheck LogoGMCheck

Dokumentasi Kunci API

Panduan lengkap penggunaan API GMCheck dengan kunci API

Ikhtisar

Kunci API memungkinkan pengguna premium untuk mengakses API verifikasi email tanpa memerlukan autentikasi masuk. Endpoint Kunci API menggunakan awalan terpisah /api/v1/ dan tidak memerlukan enkripsi.

Persyaratan

  • Hanya Paket Premium: Fitur Kunci API secara eksklusif tersedia untuk pengguna premium
  • Setiap pengguna hanya dapat memiliki satu kunci API
  • Endpoint kunci API tidak menggunakan enkripsi (permintaan/respons teks biasa)

Memulai

1. Hasilkan Kunci API

Pertama, Anda perlu menghasilkan kunci API melalui antarmuka web:

  1. Masuk ke akun Anda
  2. Klik menu profil Anda
  3. Pilih "Kunci API" (hanya terlihat untuk pengguna premium)
  4. Klik "Hasilkan Kunci API"
  5. Penting: Salin dan simpan kunci API Anda segera - Anda tidak akan dapat melihatnya lagi!

⚠️ Peringatan: Anda tidak akan dapat melihat kunci API Anda lagi setelah dibuat. Simpan dengan aman.

2. Menggunakan Kunci API

Kunci API dapat diberikan dalam tiga cara:

  1. Header X-API-Key (Direkomendasikan):
    X-API-Key: your-api-key-here
  2. Header Authorization:
    Authorization: Bearer your-api-key-here
  3. Parameter Query (Kurang aman):
    ?apiKey=your-api-key-here

Endpoint API

Semua endpoint kunci API menggunakan awalan /api/v1/ dan tidak memerlukan enkripsi.

1. Periksa Email

Kirim pekerjaan untuk memeriksa alamat 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. Dapatkan Riwayat Pekerjaan

Dapatkan daftar pekerjaan Anda yang dipaginasi.

Endpoint:

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

3. Dapatkan Statistik Pekerjaan

Dapatkan ringkasan statistik untuk pekerjaan tertentu.

Endpoint:

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

4. Dapatkan Detail Pekerjaan

Dapatkan detail pekerjaan lengkap termasuk semua hasil.

Endpoint:

GET /api/v1/jobs/:jobId

5. Dapatkan Statistik Penggunaan

Dapatkan statistik penggunaan Anda saat ini.

Endpoint:

GET /api/v1/usage

Contoh Kode

Contoh 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"

Contoh 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)

Contoh 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();
};

Nilai Status Email

  • LIVE: Email valid dan aktif
  • VERIFY: Email perlu verifikasi
  • DISABLE: Email dinonaktifkan
  • NOT_EXIST: Email tidak ada
  • UNKNOWN: Status tidak diketahui
  • PENDING: Email masih diproses

Nilai Status Pekerjaan

  • pending: Pekerjaan sedang antre dan menunggu untuk diproses
  • processing: Pekerjaan sedang diproses
  • completed: Pekerjaan telah berhasil diselesaikan
  • stopped: Pekerjaan dihentikan oleh pengguna
  • failed: Pekerjaan gagal diselesaikan

Praktik Keamanan Terbaik

  • Jangan pernah membagikan kunci API Anda: Anggap kunci API Anda seperti kata sandi
  • Gunakan variabel lingkungan: Simpan kunci API dalam variabel lingkungan, bukan dalam kode
  • Putar secara teratur: Hasilkan ulang kunci API Anda secara berkala
  • Cabut jika disusupi: Jika Anda mencurigai kunci API Anda disusupi, segera cabut
  • Gunakan hanya HTTPS: Selalu gunakan HTTPS saat membuat permintaan API
  • Monitor penggunaan: Periksa statistik penggunaan Anda secara teratur untuk mendeteksi akses yang tidak sah

Respons Kesalahan

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."
}

Dukungan

Untuk masalah atau pertanyaan mengenai kunci API, silakan hubungi dukungan melalui halaman kontak atau Telegram.