ConverterHQDevelopers
API v1

Autentikasi

API key, OAuth, scope, isolasi test/live, dan penanganan kredensial yang aman.

Integrasi server memakai Bearer API key; integrasi terdelegasi memakai OAuth 2.0 dengan PKCE melalui HQTools.

API key

Key hq_test_ dan hq_live_ dipisahkan per lingkungan. Resource dimiliki account sehingga rotasi key tidak memutus akses ke Jobs yang sudah ada.

Authorization
Authorization: Bearer hq_live_...

OAuth

Access token berupa JWT yang ditandatangani HQTools, diverifikasi lokal, dan untuk aplikasi pihak ketiga terkait consent yang dapat dicabut.

Scopes

Izin tersedia secara granular untuk Files, Jobs, Tasks, Workflows, Webhooks, Connections, Usage, Logs, signed URLs, dan realtime.

Keamanan kredensial

Jangan pernah meletakkan secret permanen di browser; gunakan signed upload, signed conversion URL, atau realtime token berumur pendek.