NoirCheck API Documentation

Public API untuk cek nickname & data game secara cepat dan simpel.

Base URL: http://localhost:3005 Response: JSON API Key: optional untuk member tracking

Auth

Public API bisa dipakai tanpa token. Member bisa mengirim API key agar usage, rate limit, dan last used tercatat.

Tanpa API Key

Cocok untuk test lokal dan public checker biasa. Rate limit dihitung per IP.

GET /api/check?game=freefire&id=30583718

Dengan API Key Member

Kirim header x-api-key. Kalau key invalid, response 401.

x-api-key: nc_xxxxxxxxxxxxxxxxx

Check ID

Endpoint utama untuk semua brand.

GET

GET/api/check?game={brand}&id={playerId}&zone={zoneId}

Param	Wajib	Contoh	Keterangan
`game`	Tidak	`freefire`	Kalau kosong, default Free Fire.
`id`	Ya	`30583718`	Player ID / UID / username.
`zone` atau `zoneId`	Kondisional	`2510`	Wajib untuk game yang butuh server/zone.

Webhook Callback

NoirCheck akan mengirim callback setelah setiap check member selesai. Response utama API tetap jalan walaupun webhook gagal.

POST

POST{webhook_url member}

Payload JSON

{
  "game": "freefire",
  "user_id": "30583718",
  "nickname": "RavenNight",
  "status": "success",
  "credit_used": 1,
  "timestamp": "2026-04-29T07:18:01.678Z"
}

Delivery Rules

Timeout webhook adalah 5 detik. NoirCheck retry maksimal 1x. Jika callback tetap gagal, error dicatat di server dan tidak mengubah response /api/check.

Gunakan endpoint HTTPS yang cepat, idempotent, dan selalu balas 2xx setelah payload diterima.

Param	Keterangan
`game`	Brand code yang dicek, contoh `freefire`, `mobilelegend`, `pubg`.
`user_id`	ID/player ID/username yang dikirim ke endpoint check.
`nickname`	Nickname hasil check. Kosong jika status failed atau provider tidak mengembalikan nama.
`status`	`success` atau `failed`.
`credit_used`	Credit yang terpotong untuk request tersebut. Duplicate/idempotent request bisa bernilai 0.
`timestamp`	Waktu callback dalam ISO string.

Security Header

x-noircheck-signature: hmac_sha256(payload, webhook_secret)

Recommended Response

{
  "received": true
}

Best practice: verifikasi signature jika memakai webhook secret, proses payload secara async di sistem kamu, dan hindari logic berat di endpoint callback.

Code Snippets

Pilih target/client. Snippet auto update mengikuti input Playground.

Target

Client

Aksi

Brand Codes

Code utama dan parameter setiap brand.

Brand	Code	Alias	Parameter	Contoh

Response Format

Success dan Error dipisah jelas. Field tambahan bisa muncul sesuai brand/provider.

Success Examples

Error / Invalid Examples

API Playground

Test endpoint langsung dari dokumentasi. Response body dan headers muncul di bawah.

Game

Zone

Response Body

{}

Kode Status Response

Status di bawah dicatat dari backend lokal NoirCheck dan dipakai sebagai referensi integrasi.

Case	Request	Status Aktual	Catatan
Sukses	`/api/check?game=freefire&id=30583718`	HTTP 200	Response JSON success.
ID kosong	`/api/check?game=freefire`	HTTP 400	`Parameter id wajib diisi`
API key kosong	`/api/member/me`	HTTP 401	Member endpoint butuh `x-api-key`.
API key salah	`/api/check?game=freefire&id=30583718`	HTTP 401	`API key tidak valid atau member dinonaktifkan.`
Credit habis	`/api/check?game=freefire&id=30583718`	HTTP 402	`Saldo credit tidak cukup. Silakan top up saldo.`
Spam / rate limit	`/api/check` berulang	HTTP 429	Global/front/member rate limit aktif.
Game salah	`/api/check?game=wrong&id=123`	HTTP 404	Brand/action tidak didukung atau ID tidak valid.