Uwierzytelnianie
Uzyskanie klucza API
Możesz utworzyć klucz API na stronie Integracje API w Ignite Admin UI. Potrzebujesz roli admin, żeby wejść na tę stronę.
Podczas tworzenia klucza wybierz jego uprawnienia oraz opcjonalny zakres kategorii.
Uprawnienia
Uprawnienia klucza API są przyznawane per zasób. Włącz tylko te akcje, których potrzebuje twoja integracja.
| Zasób | Dostępne akcje |
|---|---|
| Wideo | read, create, update, delete, publish |
| Wydarzenia na żywo | read, create, update, delete, publish |
| Tags | create, update, delete |
| Kategorie | create, update, delete |
| Analytics | read |
Dostęp do odczytu kategorii, Tags i presetów odtwarzacza jest zawsze przyznany. Nie musisz go włączać. Klucze API nie mogą tworzyć, aktualizować ani usuwać presetów odtwarzacza.
publish jest oddzielne od create i update. visibility: public jest zapisywane tylko wtedy, gdy klucz ma videos.publish. Bez tego uprawnienia tworzenie zapisuje private. PATCH, który ustawia visibility, jest akceptowany, pole pozostaje bez zmian, a odpowiedź pozostaje 200. Żaden z tych przypadków nie zwraca 403.
Endpointy Analytics wymagają analytics.read. Samo read dla wideo nie wystarczy. Zobacz Analytics.
Klucze API nie mogą zarządzać członkami, webhookami, innymi integracjami API ani ustawieniami konta.
Zakres kategorii
Możesz ograniczyć klucz API do jednej lub wielu kategorii. Zakres obejmuje te kategorie i ich podkategorie. On filtruje odczyty i zapisy wideo oraz odczyty, aktualizacje i usuwanie kategorii. Klucz z zakresem nie może usunąć kategorii, która jest jedną z kotwic jego zakresu. Jeśli tworzysz wideo i nie wyślesz żadnych kategorii, przypisywane są kategorie zakresu, maksymalnie 10. Jeśli zostawisz pole puste, klucz ma dostęp do każdej kategorii w workspace.
Zakres kategorii nie ogranicza Tags ani wydarzeń na żywo. Dotyczy wywołań analytics per wideo.
Użycie klucza API
Przekaż swój klucz API jako token Bearer w nagłówku Authorization swojego żądania.
CURL
curl -X GET https://app.ignitevideo.cloud/api/videos \
-H "Authorization: Bearer YOUR_API_KEY"Brakujący lub nieprawidłowy klucz API
Brakujący lub nieprawidłowy klucz API zwraca 403:
{
"errors": [
{
"message": "You are not allowed to perform this action"
}
]
}Kształty odpowiedzi błędów
Endpointy kolekcji (wideo, kategorie, Tags i presety odtwarzacza) zwracają błędy Payload jako { errors: [{ message }] }.
Endpointy niestandardowe (przesyłanie, zastępowanie, miniatury, text tracks, multipart upload i trasy AI) zwracają { error, message? }. Pole message jest pomijane przy niektórych błędach. Błąd uprawnień na tych trasach zwraca 403.
{
"error": "not_found"
}{
"error": "invalid_video_id"
}Pole, które nie przechodzi walidacji na endpoincie kolekcji, zwraca 400 w formacie błędu Payload.
GET brakującego wideo, kategorii lub tagu zwraca 404 { errors: [{ message: "Not Found" }] }. PATCH lub DELETE brakującego id zwraca 403 z błędem Payload powyżej. Odpowiedź jest taka sama, gdy dokument nie istnieje i gdy klucz nie może go zobaczyć.