Autentikasi
Autentikasi setiap permintaan Partner API dengan organization API key.
Setiap permintaan membawa kunci API sebagai token bearer.
Authorization: Bearer mor_live_7f3c1a9e…Sebuah kunci milik organisasi, bukan milik orang yang membuatnya. Kunci itu tetap berfungsi ketika orang tersebut pergi, dan admin organisasi mana pun dapat melihatnya tercantum serta mencabutnya.
Buat kunci
Buka Settings
Di Morphic Studio, buka dropdown organisasi (logo Morphic, kiri atas) lalu pilih Settings.
Buka API keys
Dari sidebar kiri, klik Kunci API. Tab ini hanya terlihat oleh admin.
Buat kunci
Klik Kunci baru, beri nama yang akan Anda kenali dalam sebulan, pilih cakupannya, dan — jika tidak seharusnya berlaku selamanya — tetapkan masa berlakunya.
Salin rahasianya
Rahasia hanya ditampilkan sekali. Morphic hanya menyimpan hash-nya, jadi rahasia itu tidak bisa ditampilkan lagi. Simpan di pengelola rahasia Anda sebelum Anda menutup dialog.
Siapa pun yang memegang kunci dapat memulai run yang menghabiskan kredit organisasi Anda. Perlakukan seperti kata sandi: jangan pernah commit, jangan pernah taruh di browser, jangan pernah kirim lewat email atau chat.
Cakupan
Sebuah kunci hanya memegang cakupan yang Anda berikan kepadanya. Permintaan di luar itu ditolak dengan access_denied.
| Cakupan | Memungkinkan |
|---|---|
workflows:read | membaca workflow dan input yang digunakannya |
runs:write | memulai run, serta mendaftarkan dan menghapus endpoint webhook |
runs:read | membaca status run dan aset selesaiannya, serta menampilkan daftar endpoint webhook |
Sebuah kunci juga dapat dibatasi pada workflow tertentu. Memulai hal lain apa pun ditolak, dan run dari hal lain apa pun dibaca sebagai tidak ditemukan, yang memang Anda inginkan untuk kunci yang berada dalam satu integrasi.
Lingkungan
Awalan menunjukkan deployment mana yang menjadi tempat sebuah kunci, sehingga kunci yang bocor bisa langsung dikenali. Kunci yang diajukan ke deployment lain akan ditolak.
| Awalan | Lingkungan | URL dasar |
|---|---|---|
mor_live_ | produksi | https://api.morphic.com/v1/partner |
mor_test_ | staging, untuk pekerjaan integrasi; run di sana dibatasi dan datanya bukan milik Anda | https://api.morphic.today/v1/partner |
Batas kredit
Setiap kunci memiliki batas maksimum kredit yang boleh dibelanjakan, yang ditetapkan oleh admin yang membuatnya:
| Batas | Diatur? | Arti |
|---|---|---|
| Total | selalu | kredit yang mungkin pernah dibelanjakan oleh kunci |
| Per hari | opsional | kredit per hari UTC |
| Per bulan | opsional | kredit per bulan UTC |
Satu hari adalah hari UTC dan satu bulan adalah bulan kalender UTC. Tagihan yang akan membuat kunci melampaui salah satu batasnya ditolak dengan api_key_credit_limit_reached; pesan kesalahannya error_attributes.period menyebutkan batas mana (total, bulanan atau harian). Itu adalah kondisi yang berbeda dari organisasi yang kehabisan kredit (credits_exhausted), dan cara memperbaikinya juga berbeda: seorang admin menaikkan batas kunci di Studio, bukan mengisi ulang organisasi. Sebuah start yang kuncinya sudah tidak punya ruang lagi ditolak sebelum apa pun diambil.
Run yang dimulai dengan sebuah kunci tetap dihitung terhadap kunci itu meskipun seseorang masuk ke chat di Studio dan mengambil alih. Jadi sisa anggaran kunci adalah anggaran untuk seluruh run, bukan hanya bagian otomatisnya.
Rotasi
Lakukan rotasi dengan tumpang tindih, jangan pernah dengan celah: buat kunci baru, terapkan, pastikan lalu lintas sudah berpindah, lalu cabut yang lama. Sebuah organisasi dapat memiliki hingga 10 kunci yang dapat mengautentikasi sekaligus, yang memberi ruang untuk rotasi tanpa menjadi tumpukan yang tak pernah dipensiunkan.
Pencabutan berlaku dalam hitungan detik. Run yang sudah sedang berjalan akan selesai dan tetap ditagihkan.