API
ONESTEP AI udostępnia publiczne API dla wszystkich zalogowanych użytkowników. Obejmuje ono pełną funkcjonalność portalu.
Wybierz swój region:
ONESTEP AI EU lub ONESTEP AI US
Autoryzacja odbywa się za pośrednictwem strony internetowej OSAI lub tokenu dostępu. Bardziej szczegółowe instrukcje można znaleźć w artykule dotyczącym autoryzacji lub w interfejsie API, klikając przycisk Autoryzuj.
Kody statusu odpowiedzi HTTP:
| Kod statusu | Opis {class=“compact”} |
|---|---|
| 200 - OK | Żądanie powiodło się. |
| 400 - Bad Request | Serwer nie może lub nie chce przetworzyć żądania z powodu czegoś, co jest postrzegane jako błąd klienta. |
| 401 - Unauthorized | Chociaż standard HTTP określa „nieautoryzowany”, semantycznie ta odpowiedź oznacza „nieuwierzytelniony”. Oznacza to, że klient musi się uwierzytelnić, aby uzyskać żądaną odpowiedź. |
Aby zapoznać się z interfejsem API, można znaleźć kilka przykładów korzystania z usługi w sekcji Jak korzystać z interfejsu API.
Kliknij jeden z poniższych linków, aby pobrać podręcznik Python:
Webhooki
Wdrożyliśmy system webhooków, aby usprawnić pracę z OSAI za pomocą API. Webhooki to sposób, w jaki aplikacje lub usługi mogą wysyłać powiadomienia w czasie rzeczywistym do innych aplikacji lub usług. Działają one w oparciu o prostą koncepcję: gdy w aplikacji wystąpi określone zdarzenie lub wyzwalacz, wysyła ona żądanie HTTP POST do predefiniowanego adresu URL, zawierającego odpowiednie informacje o zdarzeniu.
Nasz system webhooków pobiera informacje o zakończeniu zadań procesu roboczego (np. konwersja, manipulacja, przewidywanie, szkolenie, ponowne szkolenie, wypożyczenie urządzenia) i wysyła je pod wskazany adres. Aby skorzystać z tej funkcji, przejdź do naszej dokumentacji API (EU lub USA) zlokalizuj żądane zadanie i podaj swój adres URL. Upewnij się, że adres URL jest osiągalny, prawidłowo skonfigurowany i zdolny do odbierania i obsługi przychodzących żądań HTTP. Po zakończeniu zadania otrzymasz żądanie HTTP POST. To żądanie poinformuje Cię, czy zadanie zostało pomyślnie zakończone lub czy proces roboczy napotkał jakieś problemy po drodze.