Đọc toàn bộ API trước khi đăng ký

Tài liệu tham chiếu Engine được công khai. Tài nguyên, trường dữ liệu và lỗi đều được ghi chép kèm ví dụ, và không có gì nằm sau một biểu mẫu. Khi muốn thử một lệnh gọi, hãy đăng ký tài khoản và tạo khóa sandbox.

Để đọc
Không cần tài khoản
Định dạng
Tài liệu tham chiếu REST kèm ví dụ
Khóa sandbox
Với tài khoản đã được duyệt

Bắt đầu bằng một yêu cầu

Cách nhanh nhất để đọc một API là gọi nó. Bốn yêu cầu này là khởi đầu tốt cho giờ đầu tiên: kiểm tra khóa có hoạt động không, liệt kê những gì đang có, tạo một bản phát hành và đăng ký nhận sự kiện.

  • Mỗi endpoint được minh họa bằng một yêu cầu và một phản hồi
  • Lỗi được liệt kê kèm nguyên nhân và cách sửa
  • Các ví dụ chạy được trên sandbox đúng như đã viết

Các yêu cầu đầu tiên

Yêu cầu mẫu

GET/v1/me

Phản hồi

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

Tài liệu tham chiếu, theo tài nguyên

Bản phát hành
Tạo, cập nhật, gửi và gỡ xuống bản phát hành, cùng lãnh thổ và ngày của chúng.
Bài hát và tài sản
Thêm bài hát, tải lên âm thanh và ảnh bìa, đặt thông tin ghi công, mã và tỷ lệ chia.
Lượt gửi
Gửi một bản phát hành đến các cửa hàng và theo dõi từng điểm đến từ lúc chờ cho đến khi lên sóng hoặc bị từ chối.
Phân tích
Đọc lượt stream và lượt tải theo cửa hàng, lãnh thổ, bản phát hành, bài hát và ngày.
Tiền bản quyền
Liệt kê bảng kê, đọc các dòng của chúng và xem mỗi người nhận thanh toán được nợ bao nhiêu.
Webhook
Đăng ký một endpoint, chọn các sự kiện nó nhận và xem lại những gì đã được gửi.

Bắt đầu nhanh, trên sandbox

  1. 1

    Tạo khóa sandbox

    Đăng ký tài khoản và sao chép khóa từ đó sau khi được duyệt.

  2. 2

    Thực hiện yêu cầu đầu tiên

    Gọi /v1/me với khóa trong header Authorization để xác nhận khóa hoạt động.

  3. 3

    Tạo một bản phát hành thử

    Gửi một bản phát hành với tên bài hát và nghệ sĩ, rồi thêm một bài hát vào đó.

  4. 4

    Mô phỏng một lượt gửi

    Gửi nó trong sandbox và xem trạng thái thay đổi, không có cửa hàng nào tham gia.

Một header, là bạn vào được

Xác thực là một khóa API được gửi dưới dạng bearer token. Không có bắt tay và không có phiên nào cần duy trì. Sao chép đoạn này, thay khóa của bạn vào và chạy.

  • Sandbox và môi trường thật dùng các khóa riêng
  • Có thể thu hồi khóa bất cứ lúc nào

Liệt kê các bản phát hành của bạn

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

Câu hỏi về tài liệu

Không. Tài liệu tham khảo là công khai. Bạn chỉ cần tài khoản khi muốn có khóa.

Endpoint và phản hồi đều giống nhau. Các lượt gửi trong sandbox dừng lại trước khi đến bất kỳ cửa hàng nào, và dữ liệu sandbox được tách khỏi danh mục nhạc thật của bạn.

Các phần bổ sung được ghi trong nhật ký thay đổi. Một thay đổi gây lỗi tương thích sẽ được phát hành dưới phiên bản mới trong đường dẫn, nên phiên bản bạn đã xây dựng vẫn giữ nguyên.

Đọc trước, rồi thực hiện yêu cầu