קראו את כל ה-API לפני שמגישים בקשה

מסמך ה-Engine פתוח. משאבים, שדות ושגיאות מתועדים עם דוגמאות, ושום דבר מהם לא מאחורי טופס. כשרוצים לנסות קריאה, מגישים בקשה לחשבון ויוצרים מפתח sandbox.

לקריאה
אין צורך בחשבון
פורמט
מדריך REST עם דוגמאות
מפתחות sandbox
עם חשבון מאושר

התחילו בבקשה

הדרך המהירה ביותר להכיר API היא לקרוא לו. ארבע הבקשות האלה הן שעה ראשונה טובה: בדקו שהמפתח עובד, הציגו מה קיים, צרו שחרור והירשמו לאירועים.

  • כל נקודת קצה מוצגת עם בקשה ותגובה
  • שגיאות מפורטות עם הסיבה והתיקון
  • הדוגמאות רצות מול ה-sandbox כפי שהן כתובות

הבקשות הראשונות

בקשות לדוגמה

GET/v1/me

תגובה

{  "id": "acc_5t1m9",  "name": "Northfield Audio",  "environment": "sandbox"}

המדריך, לפי משאב

שחרורים
צרו, עדכנו, שלחו והסירו שחרורים, עם הטריטוריות והתאריכים שלהם.
שירים ונכסים
הוסיפו שירים, העלו שמע ועטיפות, וקבעו קרדיטים, קודים וחלוקות.
מסירות
שלחו שחרור לפלטפורמות ועקבו אחרי כל יעד מהמתנה בתור ועד פעיל או נדחה.
אנליטיקס
קראו השמעות והורדות לפי פלטפורמה, טריטוריה, שחרור, שיר ויום.
תמלוגים
הציגו דוחות, קראו את השורות שלהם וראו מה מגיע לכל מוטב.
Webhooks
רשמו נקודת קצה, בחרו את האירועים שהיא מקבלת ובדקו מה נשלח.

התחלה מהירה, מול ה-sandbox

  1. 1

    צרו מפתח sandbox

    הגישו בקשה לחשבון, והעתיקו ממנו את המפתח לאחר שהוא מאושר.

  2. 2

    בצעו את הבקשה הראשונה

    קראו ל-/v1/me עם המפתח בכותרת Authorization כדי לוודא שהוא עובד.

  3. 3

    צרו שחרור בדיקה

    שלחו שחרור עם כותרת ואמן, ואז הוסיפו לו שיר.

  4. 4

    הדמו מסירה

    מסרו אותו ב-sandbox וצפו בסטטוס משתנה, בלי פלטפורמה מעורבת.

כותרת אחת, ואתם בפנים

האימות הוא מפתח API שנשלח כ-bearer token. אין לחיצת יד ואין סשן שצריך לשמור פעיל. העתיקו את זה, החליפו את המפתח והריצו.

  • ה-sandbox והייצור משתמשים במפתחות נפרדים
  • אפשר לבטל מפתח בכל עת

הציגו את השחרורים שלכם

bash
curl https://api.aevorarecords.com/v1/releases \  -H "Authorization: Bearer YOUR_API_KEY"

שאלות על התיעוד

לא. התיעוד פתוח לכולם. חשבון נדרש רק כשרוצים מפתח.

נקודות הקצה והתגובות זהות. מסירות ב-sandbox נעצרות לפני כל פלטפורמה, ונתוני ה-sandbox נשמרים בנפרד מהקטלוג החי שלכם.

תוספות מצוינות ביומן השינויים. שינוי שובר תאימות יוצא תחת גרסה חדשה בנתיב, כך שהגרסה שעליה בניתם נשארת כפי שהיא.

קראו קודם, ואז שלחו בקשה