บทนำ
ยินดีต้อนรับสู่คู่มืออ้างอิง Mailtarget API ทำตามคำแนะนำนี้เพื่อเริ่มต้นใช้งาน
Mailtarget API สร้างขึ้นบน HTTP API ของเราเป็น RESTful และ:
ใช้ URL ที่มีโครงสร้างสอดคล้องกัน ซึ่งสามารถคาดการณ์ได้ง่าย
ใช้ประโยชน์จากความสามารถเฉพาะตัวของ HTTP สำหรับการส่งพารามิเตอร์และการตรวจสอบสิทธิ์
ใช้รหัสตอบกลับ HTTP มาตรฐานเพื่อระบุข้อผิดพลาด
แสดงการตอบกลับในรูปแบบ JSON
Mailtarget ได้จัดเตรียมไลบรารีสำหรับภาษาโปรแกรมหลายภาษาไว้ให้คุณเลือกใช้ คุณสามารถเลือกใช้งานไลบรารีของเรา หรือเลือกใช้ไลบรารี HTTP/REST ที่คุณต้องการ ซึ่งเข้ากันได้กับภาษาโปรแกรมของคุณ เพื่อเริ่มต้นคำขอ HTTP ไปยัง Mailtarget เราขอแนะนำให้คุณไปที่หน้าไลบรารีของเรา ซึ่งเรามีคำแนะนำเกี่ยวกับไลบรารี HTTP REST
จุดสิ้นสุด
การเรียกใช้ API ทั้งหมดต้องเริ่มต้นด้วย URL ฐานที่เหมาะสม:
Mailtarget production |
การตรวจสอบสิทธิ์
ตรวจสอบสิทธิ์คำขอแต่ละรายการโดยการตั้งค่าส่วนหัวการอนุญาตด้วยรหัส API ที่ถูกต้อง
เรายอมรับแซนด์บ็อกซ์รหัส API ต่อไปนี้:
"Authorization": provided in sandbox dashboard
เรายอมรับการผลิตคีย์ API ต่อไปนี้:
"Authorization": provide for user production
ข้อตกลง API
เครื่องหมายทับท้ายจะถูกละเว้น: /transmissions เทียบเท่ากับ /transmissions/
เส้นทาง URL ชื่อพารามิเตอร์การค้นหา URL และชื่อฟิลด์ JSON จะคำนึงถึงตัวพิมพ์เล็กและใหญ่
เส้นทาง URL จะเขียนด้วยตัวพิมพ์เล็กและมีเครื่องหมายขีดคั่นคำ
พารามิเตอร์การค้นหาและฟิลด์ JSON ใช้ camelCase
สถานะ HTTP ระบุว่าการดำเนินการล้มเหลวหรือสำเร็จ โดยมีข้อมูลเพิ่มเติมรวมอยู่ในเนื้อหาตอบกลับของ HTTP
API ทั้งหมดส่งคืนรูปแบบรหัสข้อผิดพลาด HTTP มาตรฐาน
พารามิเตอร์การค้นหาและฟิลด์เนื้อหาคำขอที่ไม่คาดคิดจะถูกละเว้น
ประเภทตัวเลข JSON ของเราถูกจำกัดด้วยจำนวนเต็ม 32 บิตที่มีเครื่องหมาย
ข้อผิดพลาด
เมื่อทำการเรียกใช้ API คุณอาจได้รับข้อความแสดงข้อผิดพลาดในการตอบสนอง ข้อความแสดงข้อผิดพลาดนี้อาจบ่งชี้ว่ามีปัญหากับคำขอของคุณหรือปัญหาที่เกิดขึ้นจากทางเรา ข้อผิดพลาดจะมาพร้อมกับรหัสข้อผิดพลาดและข้อมูล JSON ที่ให้ข้อความ คำอธิบาย และรหัส API ที่เฉพาะเจาะจงยิ่งขึ้น
422 Unprocessable Entity
{
"errors": [
{
"message": "required field is missing",
"description": "content object or template_id required",
"code": "1400"
}
]
}
ตารางข้อผิดพลาด
รหัส | ชื่อสถานะ | คำอธิบาย | การดำเนินการที่แนะนำ |
400 | คำขอไม่ถูกต้อง | มีปัญหากับคำขอของคุณ | ตรวจสอบว่าคำขอของคุณเป็นไปตามเอกสาร API และใช้ไวยากรณ์ที่ถูกต้อง |
401 | ไม่ได้รับอนุญาต | คุณไม่มีสิทธิ์ที่จำเป็นในการส่งคำขอ | โปรดตรวจสอบให้แน่ใจว่าคุณใช้คีย์ API ที่ถูกต้องและมีสิทธิ์ที่จำเป็นสำหรับคำขอของคุณ |
403 | ต้องห้าม | เซิร์ฟเวอร์เข้าใจคำขอ แต่ปฏิเสธที่จะดำเนินการ | ตรวจสอบว่าแผน Mailtarget ของคุณมีทรัพยากรที่คุณร้องขอหรือไม่ และคีย์ API ของคุณมีสิทธิ์ที่จำเป็นหรือไม่ |
404 | ไม่พบ | เซิร์ฟเวอร์ไม่พบไฟล์ที่ร้องขอ | เปลี่ยน URL คำขอของคุณให้ตรงกับปลายทาง API ที่ถูกต้อง |
405 | ไม่อนุญาตให้ใช้วิธีการ | ทรัพยากรไม่มีวิธีการที่ระบุ (เช่น PUT เมื่อส่งข้อมูล) | เปลี่ยนวิธีการให้เป็นไปตามเอกสารประกอบสำหรับทรัพยากร |
409 | ขัดแย้ง | เกิดข้อขัดแย้งจากคำขอของคุณ (เช่น มีผู้ใช้ที่ใช้อีเมลนั้นอยู่แล้ว) | แก้ไขเพย์โหลดเพื่อล้างข้อขัดแย้ง |
413 | คำขอมีขนาดใหญ่เกินไป | ขนาดของคำขอเกินขีดจำกัด | ตรวจสอบขีดจำกัดที่ระบุไว้สำหรับ API และลดขนาดของคำขอ |
415 | ประเภทสื่อที่ไม่รองรับ | คำขอไม่ได้อยู่ในรูปแบบที่รองรับ | ตรวจสอบว่าส่วนหัว Content-Type ของคุณเป็นประเภทที่รองรับ และคำขอของคุณเป็นไปตามเอกสารประกอบ |
420 | เกินขีดจำกัดการส่ง | คุณส่งเกินขีดจำกัดการส่งรายวัน รายเดือน หรือแซนด์บ็อกซ์แล้ว | ตรวจสอบว่าคุณอยู่ในขีดจำกัดของแพ็กเกจ Mailtarget ของคุณ หากคุณใช้โดเมนแซนด์บ็อกซ์ คุณจะต้องเพิ่มโดเมนการส่งเพื่อดำเนินการต่อ |
422 | เอนทิตีที่ไม่สามารถประมวลผลได้ | คำขอถูกต้องตามหลักไวยากรณ์ แต่ล้มเหลวเนื่องจากข้อผิดพลาดทางความหมาย | โปรดตรวจสอบให้แน่ใจว่าคำขอของคุณมีข้อมูลที่จำเป็นครบถ้วนและข้อมูลของคุณถูกต้อง |
429 | คำขอมากเกินไป | คุณส่งคำขอมากเกินไปในช่วงเวลาที่กำหนด | รอ 1 ถึง 5 วินาทีก่อนส่งคำขออีกครั้ง รูปแบบการใช้งานที่หนักขึ้นอาจต้องใช้กลยุทธ์การถอยกลับที่ซับซ้อนและเพิ่มขึ้นเรื่อยๆ |
500 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ | มีข้อผิดพลาดเกิดขึ้นที่ฝั่งของเรา | ลองส่งคำขออีกครั้งในภายหลัง หากข้อผิดพลาดไม่ได้รับการแก้ไข ให้ตรวจสอบการอัปเดตบริการ คุณยังสามารถติดต่อฝ่ายสนับสนุนได้หากปัญหายังคงอยู่ |
503 | บริการไม่พร้อมใช้งาน | ขณะนี้มีปริมาณการใช้งานสูงกว่าปกติ | ลองส่งคำขออีกครั้งในภายหลัง |