ในหน้านี้

เริ่มต้นใช้งาน

เริ่มต้นใช้ API อย่างรวดเร็ว

แผนของเครื่องมือ: Pro

ขอบเขต: บน /v1/data/* + /v2/* คีย์ที่ถูกต้องใช้แทนหลักฐาน ByteGuard ของเบราว์เซอร์ ยังตรวจวันหมดอายุ การเพิกถอน สมาชิก เครดิต และข้อจำกัด คีย์ไม่อนุญาตเส้นทางอื่น openapi.json และ products เป็นข้อมูลสาธารณะ

คีย์ API และเครดิต
ในหน้านี้

รับคีย์ API ของคุณ

คำเตือน

คุณต้องมีเครดิต: 20 เครดิตต่อเดือนที่รวมอยู่ในบัญชี Pro ที่ใช้งานอยู่ หรือเครดิตที่ซื้อในหน้าบัญชีของคุณ บัญชีที่ไม่มีทั้งสองอย่างจะได้รับ 403 pro_required

สำคัญ

คีย์นี้แสดงเพียงครั้งเดียว โปรดเก็บไว้อย่างปลอดภัยบนเซิร์ฟเวอร์ของคุณ

API ต้องใช้บัญชี Pro ที่ใช้งานอยู่ สร้างคีย์ API ในบัญชีของคุณแล้วคัดลอกไว้ เพราะจะแสดงเพียงครั้งเดียว เก็บเป็นความลับ NOCALL_API_KEY บนเซิร์ฟเวอร์ของคุณ และห้ามใส่ไว้ในโค้ดของเบราว์เซอร์

  1. สร้างคีย์ API ในบัญชีแล้วคัดลอกค่าที่แสดงครั้งเดียว ตั้ง NOCALL_API_KEY เป็นความลับบนเซิร์ฟเวอร์ ใช้ HTTPS และอย่าใส่คีย์ในโค้ดเบราว์เซอร์ คลังโค้ด ภาพหน้าจอ หรือบันทึก

  2. ส่งคีย์เต็มใน Authorization: Bearer โดยเว้นวรรคหลัง Bearer หนึ่งช่อง ไม่ใช้ X-API-Key และไม่ใส่คีย์ใน URL

คำขอแรกของคุณ

ส่ง POST /v2/tools พร้อมส่วนหัว Authorization: Bearer และเนื้อหา JSON ที่มี tool และ phone เช่น สำหรับ who-calls ใช้ Idempotency-Key ใหม่ทุกครั้งที่ดำเนินการ เพื่อให้ลองใหม่ได้โดยไม่ถูกเรียกเก็บซ้ำ

tools ทั้ง 44 รายการใช้งานได้ผ่าน API: เรียก POST /v2/<tool-id> หรือ POST /v2/tools โดยใส่ฟิลด์ tool ใน body แต่ละ tool มี JSON body ของตัวเองตามที่อธิบายไว้ในคู่มือ data.result มีผลลัพธ์ของ tool ใช้ตัวระบุตามตาราง

bash
REQUEST_ID="$(uuidgen)" && [ -n "$REQUEST_ID" ] &&
curl --request POST 'https://api.nocall.io/v2/tools' \
  --header "Authorization: Bearer $NOCALL_API_KEY" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $REQUEST_ID" \
  --data '{"tool":"who-calls","phone":"+12025550123","country":"US"}'

การตอบกลับ

หมายเหตุ

ตัวอย่างสมมติ ไม่ใช่ผลการค้นหาจริง ห้ามโทรหรือเปิดลิงก์ในตัวอย่าง

data.result มีผลลัพธ์ และ meta มี requestId, unitsCharged และการใช้งานในรอบนั้น เอกสารอ้างอิง API อธิบายฟิลด์ของ tools ทั้งหมด

data คือผลลัพธ์ ส่วน meta มี requestId, unitsCharged และการใช้งาน ตัวอย่างสมมติแสดงยอดหลังค้นหา ผลลัพธ์ที่ถูกต้องแม้ไม่พบข้อมูลก็ใช้1เครดิต ข้อผิดพลาดในการตรวจสอบหรือจากผู้ให้บริการและการดูยอดไม่คิดเครดิต การไม่มีข้อมูลไม่ได้ยืนยันว่าเบอร์ปลอดภัย ดู OpenAPI

เครดิตและข้อผิดพลาด

ผลลัพธ์ที่ถูกต้องแต่ละรายการใช้ 1 เครดิต แม้ไม่มีข้อมูล ส่วนข้อผิดพลาดในการตรวจสอบข้อมูลไม่มีค่าใช้จ่าย 401 หมายถึงไม่มีคีย์หรือคีย์ไม่ถูกต้อง 403 หมายถึงไม่มี Pro ที่ใช้งานอยู่ และ 429 หมายถึงเครดิตหมดหรือถึงขีดจำกัดคำขอ

คู่มือที่เกี่ยวข้อง