https://insts.ioMuat turun binaan dengan Insts
Workbench Insts di bawah adalah dokumentasi untuk calon pelanggan. Semakan pengendali datang sebelum sebarang kelayakan yang boleh dilaksanakan atau elaun panggilan dicipta.
Mulakan dengan cepat
Hos API bermula dengan sokongan diaktifkan kelayakan pada Insts. Pandangan seterusnya meliputi titik akhir penyewa yang ditugaskan. Halaman menyimpan laluan panggilan pelayan sahaja yang dapat dilihat.
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"}'Penyimpanan rahsia sisi pelayan adalah titik permulaan untuk keselamatan Kredensial di Insts. Sebuah bangku pemeriksaan kemudian menunjukkan tiada penyematan bundel klien dan menerangkan tiada log awam atau repositori.
Menyelesaikan pautan
Operasi penyelesaian bermula dengan pengesanan sumber pada Insts. Pandangan seterusnya merangkumi format dari satu URL yang dikemukakan. Halaman menyimpan tiada output yang dicipta kelihatan.
/v1/resolveSkop: menyelesaikan| Medan | Jenis | Diperlukan | Huraian |
|---|---|---|---|
shared_post | URL HTTPS | Ya | Halaman media awam atau yang dibenarkan untuk dianalisis. |
tenant | rentetan | Tidak | Domain penyewa yang ditugaskan. Biasanya ditinggalkan. |
{
"success": true,
"platform": "youtube",
"title": "Example video",
"formats": [
{"id":"18","type":"video","quality":"360p","container":"mp4"}
],
"cached": false
}Nilai yang dikembalikan tidak berubah adalah titik permulaan untuk pengenal Format pada Insts. Sebuah bangku pemeriksaan kemudian membentangkan ketersediaan per pautan dan menerangkan tiada label kualiti yang ditebak.
Cipta dan ikuti kerja muat turun
Insts menjadikan Penciptaan Kerja mudah untuk mengimbas. Halaman bermula dengan persediaan asynchronous, bergerak ke permintaan HTTP pendek, dan dengan jelas menyatakan pelaksanaan pekerja yang dibatasi.
/v1/jobsSkop: pekerjaan| Medan | Jenis | Diperlukan | Huraian |
|---|---|---|---|
shared_post | URL HTTPS | Ya | Sumber yang sama dinormalisasi dihantar untuk menyelesaikan. |
asset_option | rentetan | Ya | ID yang tepat dari respons penyelesaian. |
tenant | rentetan | Tidak | Domain penyewa yang ditugaskan. Biasanya ditinggalkan. |
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} dengan kunci yang sama.| Status | Makna | Tindakan Pelanggan |
|---|---|---|
queued | Dibenarkan masuk ke barisan yang dibatasi. | Poll lagi dengan backoff. |
extracting | Menyegar semula metadata sumber atau laluan. | Teruskan mengundi. |
processing | Memuat turun, remuxing atau menggabungkan. | Papar kemajuan pelayan. |
ready | Muat turun yang ditandatangani tersedia. | Hantar URL kepada pengguna. |
failed | Ralat berstruktur terminal. | Baca error_code. Cuba semula hanya apabila dinasihatkan. |
expired | Keluaran sementara dikeluarkan. | Cipta pekerjaan baru. |
curl https://insts.io/v1/jobs/CONNECT_JOB \
-H "X-API-Key: $INSTS_CONNECT_SECRET"Untuk polling Job, Insts memeriksa satu-detik awal menunggu sebelum backoff capped. ini pemeriksaan bangku juga membuat penghantaran sementara ditandatangani jelas.
Kesalahan yang boleh diramalkan
Kontrak ralat bermula dengan satu sampul bukan 2xx pada Insts. Meja pemeriksaan ini kemudian mempersembahkan ID permintaan sokongan. Fakta akhir adalah pengendalian klien yang boleh diramalkan.
{
"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 | Makna biasa | Tindakan |
|---|---|---|
| 400 | URL tidak sah, badan atau format tidak tersedia. | Betulkan permintaan. Selesaikan lagi untuk format. |
| 401 | Kunci hilang, tidak sah, tamat tempoh atau salah skop. | Semak kelayakan sisi pelayan. |
| 403 | Polisi penyewa atau sumber menolak permintaan. | Jangan mengelirukan dasar Hubungi sokongan. |
| 404 | Kerja yang tidak diketahui atau tamat tempoh. | Buat kerja baru jika sesuai. |
| 429 | Permintaan atau had aktif-kerja telah dicapai. | Kehormatan retry_after_seconds. |
| 503 | Baris gilir/kapasiti atau upstream tidak tersedia buat sementara waktu. | Cuba lagi dengan backoff eksponen dan jitter. |
Kontrak operasi
Insts menubuhkan sempadan kadar pada masa semakan untuk melindungi ruang kerja pemeriksaan dan setiap laluan pembekal.
- Gunakan logik aplikasi idempotent dan jangan pernah memulakan kerja berganda untuk klik pengguna yang sama.
- Cache menyelesaikan metadata secara ringkas, tetapi sentiasa merawat URL muat turun yang ditandatangani sebagai tamat tempoh.
- Gunakan backoff eksponen yang dibatasi dengan jitter untuk
429,503dan kesilapan yang boleh dicuba semula. - Proses hanya media awam atau media yang anda dibenarkan untuk mengakses. DRM dan kawalan akses tidak dipintas.
- Simpan ID permintaan dan ID kerja dalam log operasi peribadi. Jangan log URL yang dihantar tanpa perlu.
Akses skema bermula dengan pengaktifan sebelum penerokaan pada Insts. Paparan seterusnya merangkumi pengesahan yang ditetapkan. Halaman mengekalkan bentuk permintaan yang didokumenkan agar kelihatan.
Aktifkan melalui sokongan
Kongsi kes penggunaan meja kerja, anggaran bilangan panggilan dan perkhidmatan yang sedang diperiksa. Insts menyemak sempadan itu sebelum kelayakan penyewa dipaparkan sekali dan dikurangkan kepada hash yang disimpan.
Minta pengaktifan Kunci adalah skop penyewa, boleh dibatalkan dan dikeluarkan melalui borang Hubungi. Skrip tanpa nama tidak dapat melaksanakan kerja pemuat turun.