https://insts.ioBuduj pobrania z Insts
Poniższy warsztat Insts to dokumentacja dla potencjalnego klienta. Przegląd operatora poprzedza utworzenie jakichkolwiek wykonywalnych poświadczeń lub uprawnień do wywołań.
Szybki start
Gospodarz API zaczyna się od poświadczeń z włączoną obsługą na Insts. Następny widok obejmuje przypisany punkt końcowy dzierżawy. Strona zachowuje widoczną ścieżkę wywołań tylko po stronie serwera.
X-API-Key: pending_activation_…InstsConnectv1# Available only after support activation
export INSTS_CONNECT_SECRET="issued-after-review"
curl -X POST https://insts.io/v1/resolve \
-H "X-API-Key: $INSTS_CONNECT_SECRET" \
-H "Content-Type: application/json" \
-d '{"shared_post":"https://www.youtube.com/watch?v=VIDEO_ID"}'Bezpieczne przechowywanie sekretów po stronie serwera to punkt wyjścia dla bezpieczeństwa danych uwierzytelniających w Insts. Następnie stanowisko kontrolne nie wykazuje osadzania w pakiecie po stronie klienta i nie ujawnia publicznych dzienników ani repozytoriów.
Rozwiązywanie linku
Operacja Resolve rozpoczyna się od wykrycia źródła w Insts. Następny widok obejmuje formaty z jednego przesłanego adresu URL. Strona nie wyświetla żadnych wymyślonych wyników.
/v1/resolveZakres: rozwiązać| Field | Typ | Wymagane | Opis |
|---|---|---|---|
shared_post | Adres HTTPS | Tak | Strona publiczna lub autoryzowane media do analizy. |
tenant | ciąg znaków | Nie | Przypisana domena dzierżawy. Zazwyczaj pomijany. |
{
"success": true,
"platform": "youtube",
"title": "Example video",
"formats": [
{"id":"18","type":"video","quality":"360p","container":"mp4"}
],
"cached": false
}Zwrócona wartość bez zmian stanowi punkt wyjścia dla identyfikatora formatu w Insts. Następnie stanowisko inspekcyjne przedstawia dostępność dla każdego łącza i wyjaśnia, że nie ma zgadywanej etykiety jakości.
Tworzenie i śledzenie zadania pobierania
Insts sprawia, że tworzenie zadań jest łatwe do przejrzenia. Strona zaczyna się od asynchronicznego przygotowania, przechodzi do krótkiego żądania HTTP i wyraźnie określa ograniczone wykonanie przez pracowników.
/v1/jobsZakres: oferty pracy| Field | Typ | Wymagane | Opis |
|---|---|---|---|
shared_post | Adres HTTPS | Tak | To samo znormalizowane źródło złożone do rozwiązania. |
asset_option | ciąg znaków | Tak | Dokładny identyfikator z odpowiedzi na żądanie rozpoznania. |
tenant | ciąg znaków | Nie | Przypisana domena dzierżawy. Zazwyczaj pomijany. |
curl -X POST https://insts.io/v1/jobs \
-H "X-API-Key: $INSTS_CONNECT_SECRET" \
-H "Content-Type: application/json" \
-d '{"shared_post":"https://www.youtube.com/watch?v=VIDEO_ID","asset_option":"18"}'connect_job.GET /v1/jobs/{connect_job} tym samym kluczem.| Status | Znaczenie | Akcja klienta |
|---|---|---|
queued | Przyjęty do ograniczonej kolejki. | Ankieta ponownie z backoff. |
extracting | Odświeżanie metadanych źródłowych lub trasy. | Kontynuuj ankietowanie. |
processing | Pobieranie, remiksowanie lub łączenie. | Wyświetlanie postępu serwera. |
ready | Podpisane pobieranie jest dostępne. | Wyślij adres URL do użytkownika. |
failed | Błąd struktury terminala. | Read error_code. Powtórz próbę tylko wtedy, gdy jest to zalecane. |
expired | Tymczasowe wyjście zostało usunięte. | Utwórz nowe zadanie. |
curl https://insts.io/v1/jobs/CONNECT_JOB \
-H "X-API-Key: $INSTS_CONNECT_SECRET"W przypadku odpytywania zadań Insts sprawdza jednosekundowy początkowy czas oczekiwania przed ograniczonym wykładniczym wycofywaniem. Ten stół inspekcyjny również wyraźnie określa tymczasową podpisaną dostawę.
Błędy przewidywalne
Kontrakt błędu zaczyna się od jednej koperty spoza zakresu 2xx na Insts. Ten stół inspekcyjny następnie przedstawia identyfikator zgłoszenia do wsparcia. Ostatecznym faktem jest przewidywalna obsługa klienta.
{
"success": false,
"error": {
"code": "RATE_LIMITED",
"category": "rate_limited",
"message": "Too many requests. Please try again shortly.",
"retryable": true,
"details": {"retry_after_seconds": 20}
},
"request_id": "…"
}| HTTP | Typowe znaczenie | Akcja |
|---|---|---|
| 400 | Nieprawidłowy adres URL, treść lub niedostępny format. | Popraw żądanie. Rozwiąż ponownie dla formatów. |
| 401 | Brakujący, nieprawidłowy, wygasły lub o niewłaściwym zakresie klucz. | Sprawdź poświadczenia po stronie serwera. |
| 403 | Polityka najemcy lub źródła odrzuciła żądanie. | Nie omijać zasad. Skontaktuj się z pomocą techniczną. |
| 404 | Nieznane lub wygasłe zadanie. | Utwórz nowe zadanie, jeśli to konieczne. |
| 429 | Osiągnięto limit żądań lub aktywnych zadań. | Honor retry_after_seconds. |
| 503 | Kolejka/pojemność lub źródło tymczasowo niedostępne. | Powtórz próbę z wykładniczym cofaniem i drganiami. |
Kontrakt operacyjny
Insts ustanawia granice szybkości w czasie przeglądu, aby chronić obszar roboczy inspekcji i każdą trasę dostawcy.
- Używaj logiki aplikacji idempotent i nigdy nie uruchamiaj zduplikowanych zadań dla tego samego kliknięcia użytkownika.
- Pamięć podręczna rozwiązuje metadane krótko, ale zawsze traktuje podpisane adresy URL pobierania jako wygasające.
- Użyj ograniczonego wykładniczego opóźnienia z jitterem dla
429,503i błędów do ponownego próbowania. - Przetwarzaj tylko publiczne media lub media, do których masz uprawnienia dostępu. DRM i kontrole dostępu nie są omijające.
- Przechowuj identyfikatory żądań i identyfikatory zadań w prywatnych dziennikach operacyjnych. Nie rejestruj niepotrzebnie przesłanych adresów URL.
Dostęp do schematu zaczyna się od aktywacji przed eksploracją na Insts. Następny widok obejmuje przypisaną autentykację. Strona utrzymuje udokumentowane kształty żądań widoczne.
Aktywacja poprzez wsparcie
Udostępnij przypadek użycia workbench, szacowaną liczbę wywołań oraz usługi objęte inspekcją. Insts sprawdza tę granicę, zanim poświadczenie dzierżawcy zostanie wyświetlone jeden raz i zredukowane do przechowywanego skrótu.
Prośba o aktywację Klucze są ograniczone do dzierżawcy, odwołalne i wydawane za pośrednictwem formularza Kontakt. Anonimowe skrypty nie mogą wykonywać pracy pobierania.