Vận hành phân phối từ chính sản phẩm của bạn
Engine là API của Aevora. Tạo bản phát hành, gửi đến cửa hàng, đọc phân tích và chạy tính tiền bản quyền qua REST, ngay trong sản phẩm mà khách hàng của bạn đang dùng. Tài liệu được công khai và có sandbox để bạn xây dựng thử.
- Giao diện
- REST và JSON
- Xác thực
- Khóa API, một bộ cho mỗi môi trường
- Sandbox
- Gửi thử, không có cửa hàng nào tham gia
Bốn lệnh gọi đưa bản phát hành từ bản nháp đến bảng kê
API đi theo hành trình của một bản phát hành trên bảng điều khiển: tạo, gửi, đọc số liệu khi chúng về, rồi đọc bảng kê. Chọn một lệnh gọi để xem bạn gửi gì và nhận lại gì.
- Yêu cầu và phản hồi đều là JSON
- Lỗi chỉ rõ trường nào thất bại và vì sao
- Cùng các lệnh gọi hoạt động trong sandbox và môi trường thật
API Engine
Yêu cầu mẫuPOST/v1/releases
Nội dung yêu cầu
{ "title": "Night Drive", "artist": "Mira Kaya", "label": "Northfield Audio", "release_date": "2027-03-12"}Phản hồi
{ "id": "rel_8f2k1", "status": "draft", "upc": null}Những gì nằm quanh các endpoint
Các lệnh gọi chỉ là phần ngắn của một tích hợp. Đây là những phần giữ cho nó chạy ổn khi không ai theo dõi.
- Webhook
- Nhận sự kiện khi một lượt gửi đổi trạng thái, một bản phát hành lên sóng hoặc một bảng kê sẵn sàng, để bạn không phải liên tục hỏi lại.
- Khóa idempotency
- Gửi kèm một khóa với yêu cầu ghi, và khi thử lại sẽ nhận kết quả đầu tiên thay vì tạo bản phát hành thứ hai.
- Phân trang
- Danh sách trả về một con trỏ. Gửi lại con trỏ đó để lấy trang kế tiếp, luôn theo cùng một thứ tự.
- Sandbox
- Một môi trường riêng với khóa riêng. Các lượt gửi chạy từ đầu đến cuối và dừng lại trước khi đến bất kỳ cửa hàng nào.
- Phiên bản
- Phiên bản là một phần của đường dẫn. Thay đổi gây lỗi tương thích được phát hành dưới phiên bản mới, nên phiên bản bạn đã xây dựng vẫn giữ nguyên.
- Giới hạn tốc độ
- Mỗi phản hồi cho bạn biết hạn mức còn lại bao nhiêu, và một yêu cầu bị giới hạn cho biết khi nào nên thử lại.
Từ khóa đầu tiên đến lượt gửi thật
- 1
Lấy khóa của bạn
Đăng ký tài khoản. Sau khi được duyệt, hãy tạo khóa sandbox.
- 2
Xây dựng trên sandbox
Tạo bản phát hành và chạy các lượt gửi thử cho đến khi tích hợp của bạn xử lý được mọi trạng thái.
- 3
Yêu cầu quyền truy cập môi trường thật
Cho chúng tôi biết bạn đang xây dựng gì. Chúng tôi xem xét và cấp khóa môi trường thật.
- 4
Gửi đi
Chuyển sang khóa môi trường thật và cùng các lệnh gọi đó sẽ đến các cửa hàng thật.