<aside> 🔖 Table of Contents

</aside>

1. Using API

Base URL

<https://api.developer.oho.chat>

Authorization

ส่ง API Key แนบมาใน headers เพื่อยืนยันตัวตนในฐานะ partner developer

x-oho-api-key: <your_app_api_key>

Note: your_app_api_key ทาง Oho Chat จะเป็นคน generate ให้

Content Negotiation

ทุก API รองรับการจัดการข้อมูลในรูปแบบ JSON ทั้งใน request body และ response data โดยจำเป็นต้องระบุประเภทข้อมูลที่ใช้ใน request header ด้วย ดังนี้

Content-Type: application/json

Response

Successful response

ในกรณีที่ดำเนินการสำเร็จ ระบบจะส่งคืนค่าในรูปแบบต่อไปนี้:

{
	"ok": true,
  "status_code": 201
  "message": "Created resource successfully",
  "data": { /* ...data payload, if any... */ }
}

Error response

ในกรณีที่เกิดข้อผิดพลาด (error) ขึ้น ระบบจะส่งคืนค่าในรูปแบบต่อไปนี้:

{
	"ok": false,
  "status_code": 400
  "message": "Bad request"
}

Social profile

หมายถึงข้อมูลที่เกี่ยวข้องกับบัญชีโซเชียลมีเดียของผู้ติดต่อ(contact)นั้น ๆ ซึ่งใช้เพื่อระบุตัวตนของผู้ติดต่อ(contact)