Διαβάστε ολόκληρο το API πριν κάνετε αίτηση

Η αναφορά του Engine είναι ανοιχτή. Οι πόροι, τα πεδία και τα σφάλματα τεκμηριώνονται με παραδείγματα και τίποτα δεν βρίσκεται πίσω από φόρμα. Όταν θέλετε να δοκιμάσετε μια κλήση, κάντε αίτηση για λογαριασμό και δημιουργήστε ένα κλειδί sandbox.

Για ανάγνωση
Δεν χρειάζεται λογαριασμός
Μορφή
Τεκμηρίωση REST με παραδείγματα
Κλειδιά sandbox
Με εγκεκριμένο λογαριασμό

Ξεκινήστε με ένα αίτημα

Ο πιο γρήγορος τρόπος να διαβάσετε ένα API είναι να το καλέσετε. Αυτά τα τέσσερα αιτήματα κάνουν μια καλή πρώτη ώρα: ελέγξτε ότι το κλειδί σας λειτουργεί, δείτε τι υπάρχει, δημιουργήστε μια κυκλοφορία και εγγραφείτε σε συμβάντα.

  • Κάθε endpoint εμφανίζεται με ένα αίτημα και μια απάντηση
  • Τα σφάλματα παρατίθενται με την αιτία και τη διόρθωση
  • Τα παραδείγματα τρέχουν στο sandbox όπως είναι γραμμένα

Πρώτα αιτήματα

Παραδείγματα αιτημάτων

GET/v1/me

Απόκριση

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

Η τεκμηρίωση, ανά πόρο

Κυκλοφορίες
Δημιουργήστε, ενημερώστε, υποβάλετε και αποσύρετε κυκλοφορίες, με τις περιοχές και τις ημερομηνίες τους.
Κομμάτια και αρχεία
Προσθέστε κομμάτια, ανεβάστε ήχο και εξώφυλλα και ορίστε συντελεστές, κωδικούς και διαμοιρασμούς.
Παραδόσεις
Στείλτε μια κυκλοφορία στα καταστήματα και παρακολουθήστε κάθε προορισμό από την αναμονή μέχρι την ενεργοποίηση ή την απόρριψη.
Αναλυτικά
Διαβάστε streams και λήψεις ανά κατάστημα, περιοχή, κυκλοφορία, κομμάτι και ημέρα.
Royalties
Δείτε τις καταστάσεις, διαβάστε τις γραμμές τους και δείτε τι οφείλεται σε κάθε δικαιούχο.
Webhooks
Καταχωρίστε ένα endpoint, επιλέξτε τα συμβάντα που λαμβάνει και ελέγξτε τι στάλθηκε.

Γρήγορη εκκίνηση, στο sandbox

  1. 1

    Δημιουργήστε κλειδί sandbox

    Κάντε αίτηση για λογαριασμό και αντιγράψτε το κλειδί από αυτόν μόλις εγκριθεί.

  2. 2

    Κάντε το πρώτο σας αίτημα

    Καλέστε το /v1/me με το κλειδί στην κεφαλίδα Authorization για να επιβεβαιώσετε ότι λειτουργεί.

  3. 3

    Δημιουργήστε μια δοκιμαστική κυκλοφορία

    Υποβάλετε μια κυκλοφορία με τίτλο και καλλιτέχνη και μετά προσθέστε ένα κομμάτι.

  4. 4

    Προσομοιώστε μια παράδοση

    Παραδώστε την στο sandbox και δείτε την κατάσταση να αλλάζει, χωρίς κανένα κατάστημα.

Μία κεφαλίδα και μπήκατε

Η ταυτοποίηση είναι ένα κλειδί API που αποστέλλεται ως bearer token. Δεν υπάρχει handshake ούτε συνεδρία να διατηρείτε ενεργή. Αντιγράψτε το, βάλτε το κλειδί σας και τρέξτε το.

  • Το sandbox και η παραγωγή χρησιμοποιούν ξεχωριστά κλειδιά
  • Ένα κλειδί μπορεί να ανακληθεί ανά πάσα στιγμή

Λίστα των κυκλοφοριών σας

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

Ερωτήσεις για την τεκμηρίωση

Όχι. Η αναφορά είναι δημόσια. Χρειάζεστε λογαριασμό μόνο όταν θέλετε κλειδί.

Τα endpoints και οι απαντήσεις είναι ίδια. Οι παραδόσεις στο sandbox σταματούν πριν από οποιοδήποτε κατάστημα και τα δεδομένα του sandbox μένουν χωριστά από τον ενεργό κατάλογό σας.

Οι προσθήκες καταγράφονται στο changelog. Μια αλλαγή που σπάει τη συμβατότητα κυκλοφορεί με νέα έκδοση στη διαδρομή, ώστε η έκδοση για την οποία χτίσατε να μένει όπως είναι.

Διαβάστε πρώτα, μετά κάντε αίτημα