อ่าน API ทั้งหมดก่อนสมัคร
เอกสารอ้างอิง Engine เปิดให้ทุกคน ทรัพยากร ฟิลด์ และข้อผิดพลาดมีเอกสารพร้อมตัวอย่าง และไม่มีส่วนใดอยู่หลังแบบฟอร์ม เมื่อต้องการลองเรียกใช้ ให้สมัครบัญชีแล้วสร้างคีย์แซนด์บ็อกซ์
- การอ่าน
- ไม่ต้องมีบัญชี
- รูปแบบ
- เอกสารอ้างอิง REST พร้อมตัวอย่าง
- คีย์แซนด์บ็อกซ์
- เมื่อมีบัญชีที่ได้รับอนุมัติ
เริ่มจากคำขอหนึ่งครั้ง
วิธีอ่าน API ที่เร็วที่สุดคือเรียกใช้มัน สี่คำขอนี้เหมาะกับชั่วโมงแรก ได้แก่ ตรวจว่าคีย์ใช้ได้ แสดงรายการที่มี สร้างรีลีส และสมัครรับอีเวนต์
- แต่ละเอ็นด์พอยต์แสดงพร้อมคำขอและการตอบกลับ
- ข้อผิดพลาดแสดงพร้อมสาเหตุและวิธีแก้
- ตัวอย่างรันบนแซนด์บ็อกซ์ได้ตามที่เขียนไว้
คำขอแรก
ตัวอย่างคำขอGET/v1/me
การตอบกลับ
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}เอกสารอ้างอิงแยกตามรีซอร์ส
- รีลีส
- สร้าง อัปเดต ส่ง และถอดรีลีส พร้อมดินแดนและวันที่
- แทร็กและไฟล์
- เพิ่มแทร็ก อัปโหลดเสียงและอาร์ตเวิร์ก และตั้งเครดิต รหัส และสัดส่วนแบ่ง
- การส่งมอบ
- ส่งรีลีสไปยังสโตร์และติดตามแต่ละปลายทางตั้งแต่อยู่ในคิวจนออนไลน์หรือถูกปฏิเสธ
- การวิเคราะห์
- อ่านสตรีมและการดาวน์โหลดตามสโตร์ ดินแดน รีลีส แทร็ก และวัน
- รอยัลตี้
- แสดงรายการสเตตเมนต์ อ่านรายการภายใน และดูว่าผู้รับเงินแต่ละคนมียอดค้างเท่าไร
- เว็บฮุก
- ลงทะเบียนเอ็นด์พอยต์ เลือกอีเวนต์ที่จะได้รับ และตรวจดูสิ่งที่ส่งไป
เริ่มต้นอย่างรวดเร็ว บนแซนด์บ็อกซ์
- 1
สร้างคีย์แซนด์บ็อกซ์
สมัครบัญชี แล้วคัดลอกคีย์จากบัญชีนั้นเมื่อได้รับอนุมัติ
- 2
ส่งคำขอแรกของคุณ
เรียก /v1/me พร้อมคีย์ในเฮดเดอร์ Authorization เพื่อยืนยันว่าใช้งานได้
- 3
สร้างรีลีสทดสอบ
โพสต์รีลีสพร้อมชื่อเพลงและศิลปิน แล้วเพิ่มแทร็กเข้าไป
- 4
จำลองการส่งมอบ
ส่งมอบในแซนด์บ็อกซ์และดูสถานะเปลี่ยนไป โดยไม่เกี่ยวกับสโตร์
เฮดเดอร์เดียว แล้วคุณก็เข้าได้
การยืนยันตัวตนคือคีย์ API ที่ส่งเป็นเบียเรอร์โทเค็น ไม่มีการจับมือและไม่มีเซสชันที่ต้องรักษาไว้ คัดลอกอันนี้ ใส่คีย์ของคุณ แล้วรัน
- แซนด์บ็อกซ์และระบบจริงใช้คีย์แยกกัน
- เพิกถอนคีย์ได้ทุกเมื่อ
แสดงรายการรีลีสของคุณ
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"คำถามเกี่ยวกับเอกสาร
ไม่ต้อง เอกสารอ้างอิงเปิดเป็นสาธารณะ คุณต้องมีบัญชีเมื่อต้องการคีย์เท่านั้น
เอ็นด์พอยต์และการตอบกลับเหมือนกัน การส่งมอบในแซนด์บ็อกซ์หยุดก่อนถึงสโตร์ และข้อมูลแซนด์บ็อกซ์แยกจากแคตตาล็อกจริงของคุณ
ส่วนที่เพิ่มเข้ามาจะบันทึกไว้ในบันทึกการเปลี่ยนแปลง การเปลี่ยนแปลงที่ทำให้ใช้งานร่วมกันไม่ได้จะออกเป็นเวอร์ชันใหม่ในพาธ เวอร์ชันที่คุณพัฒนาไว้จึงคงเดิม