https://insts.ioИзграждане на изтегляния с Insts
Работната пейка Insts по-долу е документация за потенциален клиент. Прегледът от оператор идва преди създаването на какъвто и да е изпълним идентификационен документ или разрешение за повикване.
Бърз старт
API хостът започва с активирани с поддръжка идентификационни данни на Insts. Следващият изглед обхваща зададен крайна точка на наемател. Страницата поддържа видим път на повикване само към сървъра.
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"}'Сървърното съхранение на тайни е отправната точка за безопасността на удостоверенията в Insts. Тестовата среда след това не показва вграждане на клиентски пакет и не обяснява публични дневници или хранилища.
Разрешаване на връзка
Операцията за разрешаване започва с откриване на източника на Insts. Следващият изглед обхваща формати от един подаден URL адрес. Страницата не показва измислени изходи.
/v1/resolveОбхват: решаване| Поле | Тип | Задължително | Описание на продукта |
|---|---|---|---|
shared_post | HTTPS адрес | Да | Публична или упълномощена медийна страница, която да анализира. |
tenant | низ | Не. | Присвоен домейн на наемателя. Обикновено се пропуска. |
{
"success": true,
"platform": "youtube",
"title": "Example video",
"formats": [
{"id":"18","type":"video","quality":"360p","container":"mp4"}
],
"cached": false
}Върнатата непроменена стойност е отправната точка за идентификатора на формата на Insts. След това инспекционна маса представя наличността по връзки и обяснява липсата на предполагаема етикет за качество.
Създаване и проследяване на задача за изтегляне
Insts улеснява създаването на задачи за бързо сканиране. Страницата започва с асинхронна подготовка, преминава към кратка HTTP заявка и ясно посочва ограничено изпълнение на работника.
/v1/jobsОбхват: работни места| Поле | Тип | Задължително | Описание на продукта |
|---|---|---|---|
shared_post | HTTPS адрес | Да | Същият нормализиран източник, подаден за разрешаване. |
asset_option | низ | Да | Точен идентификатор от отговора за разрешаване. |
tenant | низ | Не. | Присвоен домейн на наемателя. Обикновено се пропуска. |
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} със същия ключ.| Състояние | Значение | Действие на клиента |
|---|---|---|
queued | Допуснат до ограничената опашка. | Анкета отново с отстъпление. |
extracting | Обновяване на изходните метаданни или маршрут. | Продължете да гласувате. |
processing | Изтегляне, ремиксиране или сливане. | Показване на напредъка на сървъра. |
ready | Подписано изтегляне е налично. | Изпратете адреса на потребителя. |
failed | Терминална структурирана грешка. | Прочетете error_codeПовторете опита само когато ви бъде препоръчано. |
expired | Временният изход беше премахнат. | Създаване на нова работа. |
curl https://insts.io/v1/jobs/CONNECT_JOB \
-H "X-API-Key: $INSTS_CONNECT_SECRET"За проверка на задачата, Insts прави едносекундно първоначално изчакване преди ограничено оттегляне. Тази инспекционна платформа също прави временно подписана доставка ясна.
Предсказуеми грешки
Договорът за грешки започва с един конверт, различен от 2xx, на Insts. Тази инспекционна пейка след това представя идентификатор на заявка за поддръжка. Последният факт е предвидимо обработване от клиента.
{
"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 | Типично значение | Действие |
|---|---|---|
| 400 | Невалиден адрес, тяло или недостъпен формат. | Коригирайте заявката. Решете отново за формати. |
| 401 | Липсва, невалиден, изтекъл или с грешен обхват ключ. | Проверете идентификационните данни от страна на сървъра. |
| 403 | Наемател или източник политика отхвърли искането. | Не заобикаляйте правилата. Свържете се с поддръжката. |
| 404 | Неизвестна или изтекла работа. | Създайте нова работа, ако е подходящо. |
| 429 | Достигане на ограничението за заявки или активни задачи. | Чест. retry_after_seconds. |
| 503 | Опашка/капацитет или нагоре по веригата временно недостъпни. | Опитайте отново с експоненциално отстъпление и трептене. |
Договор за експлоатация
Insts установява граници на ставките по време на преглед, за да защити работното пространство за инспекция и всеки доставчик.
- Използвайте idempotent логика на приложението и никога не започват дублирани работни места за един и същ потребител клик.
- Кешът разрешава метаданните за кратко, но винаги третира подписаните адреси за изтегляне като изтичащи.
- Използвайте ограничен експоненциален отстъп с трептене за
429,503и повторяеми грешки. - Обработвайте само публични медии или медии, до които имате разрешение за достъп. DRM и контролите за достъп не се заобикалят.
- Съхранявайте идентификационните номера на заявките и идентификационните номера на задачите в частни оперативни регистрационни файлове.
Достъпът до схемата започва с активиране преди изследване на Insts. Следващият изглед обхваща зададена автентикация. Страницата поддържа видими документирани форми на заявките.
Активиране чрез поддръжка
Споделете случая на използване на работната маса, приблизителния брой обаждания и услугите под проверка. Insts преглежда тази граница преди да се покаже веднъж идентификационен данни на наемател и да се намали до съхранен хеш.
Заявка за активиране Ключовете са с обхват на наемателя, отменяеми и издадени чрез формата за връзка.Анонимните скриптове не могат да изпълняват работа за изтегляне.