Developer key

API key cho phép backend của tổ chức bạn gọi Wandura Delivery API. Thành viên có vai trò developer hoặc admin tự tạo, xoay vòng và thu hồi key trên màn hình Developers của cổng đối tác. Trang này hướng dẫn phía cổng; về cách gửi key trong mỗi request, xem Xác thực.

Mở màn hình Developers#

• Developer đăng nhập là vào thẳng màn hình này; đây là màn hình duy nhất họ có.
• Admin tìm thấy nó trong Setup → Developers trên thanh bên.

Nếu bạn cần màn hình này mà không thấy, hãy nhờ admin của tổ chức cấp cho bạn vai trò developer. Xem Team và tổ chức.

Scope#

Mỗi key mang một hoặc nhiều scope, và chỉ gọi được các endpoint mà scope của nó cho phép. Scope nào mở endpoint nào nằm trong một bảng duy nhất: Xác thực · Scope.

Cảnh báo: Nếu playback key bị lộ, bất kỳ ai cũng stream được các phim bạn được cấp phép. Hãy thu hồi ngay. Cổng hiện cảnh báo này trên thẻ chọn và một lần nữa cạnh key mới.

Tạo key#

1. Mở Developers.
2. Trong Create a key, nhập Label cho biết key được dùng ở đâu, ví dụ cms-prod. Tối đa 80 ký tự.
3. Trong What will this key do?, chọn một mục đích: Stream films in an app, Stream open video (fitness…) (sẽ yêu cầu bạn chọn một app), Sync catalog to your CMS hoặc Receive creatives / webhooks. Để tự chọn scope, chọn Advanced: choose scopes.
4. Bấm Create key.
5. Sao chép key từ hộp vừa hiện ra bằng Copy key, rồi lưu vào trình quản lý secret của bạn.
6. Bấm I saved it để đóng hộp.

Cảnh báo: Key đầy đủ chỉ hiển thị một lần. Wandura không hiển thị lại được. Nếu làm mất, hãy xoay vòng key hoặc tạo key mới.

Chỉ giữ key trên server của bạn. Không bao giờ đặt key trong trang web chạy trên trình duyệt, ứng dụng di động hay repository công khai.

Danh sách key#

Danh sách Keys hiển thị mọi key của tổ chức, mới nhất trước. Với mỗi key, bạn thấy:

• Vài ký tự đầu của key theo sau là …, và nhãn của key.
• Các scope của key.
• Trạng thái: Never used, Last used ngày giờ, hoặc Revoked.

Xoay vòng key#

Xoay vòng thay secret của key và giữ nguyên nhãn cùng scope.

1. Bấm Rotate trên key.
2. Xác nhận bằng Rotate key. Secret hiện tại ngừng hoạt động trong vài giây (xem Bảo mật).
3. Sao chép key mới từ hộp vừa hiện ra. Giống như key mới tạo, key này chỉ hiển thị một lần.

Hãy cập nhật server ngay sau khi xoay vòng: không có thời gian chồng lấn. Key đã xoay vòng giữ nguyên phiên bản API đã ghim; key mới nhận phiên bản mới nhất. Bạn không xoay vòng được key đã thu hồi. Playback key xoay vòng như mọi key khác; để đổi không gián đoạn, hãy tạo playback key thứ hai, triển khai nó, rồi mới thu hồi key cũ.

Thu hồi key#

1. Bấm Revoke trên key.
2. Xác nhận bằng Revoke key.

Request mới dùng key này bị từ chối trong vài giây, và thu hồi không thể hoàn tác. Vé đã cấp vẫn phát tiếp cho đến khi hết hạn (tối đa 30 phút). Key vẫn nằm trong danh sách với nhãn Revoked.

Cảnh báo: Thu hồi playback key sẽ dừng việc phát mới trong app của bạn trong vài giây. Nếu nghi key đã bị lộ, vẫn thu hồi ngay, rồi tạo playback key mới cho server và báo cho Wandura. Quy trình đầy đủ: Bảo mật · Nếu key bị lộ.

Bước tiếp theo#

• Xác thực
• Tài liệu tham chiếu API