Anda boleh mencipta beberapa kunci API untuk tujuan yang berbeza, contohnya satu untuk aplikasi iOS anda dan satu lagi untuk aplikasi web anda. Meshy menjejaki penggunaan setiap kunci secara berasingan, dan anda boleh membatalkan kunci pada bila-bila masa.
Anda juga boleh menetapkan had kredit bulanan pada mana-mana kunci. Had ini mengehadkan apa yang kunci tersebut boleh belanjakan, tidak kira penggunaan keseluruhan akaun anda. Sebagai contoh, gunakannya untuk kunci yang anda berikan kepada kontraktor atau gunakan dalam satu persekitaran.
Untuk mencipta kunci API, ikuti langkah-langkah ini:
Pada halaman API Keys, klik Create API Key.
Dalam Name, masukkan nama untuk kunci itu.
Pilihan: Dalam Monthly credit limit (optional), masukkan jumlah kredit maksimum yang kunci itu boleh belanjakan setiap bulan.
Klik Create.
Salin kunci itu, dan simpan di tempat yang selamat. Anda tidak boleh melihat kunci itu semula selepas anda menutup dialog.
Guna kunci API
Hantar kunci API dalam header Authorization bagi setiap permintaan, sebagai token Bearer:
Senarai dibenarkan IP mengehadkan kunci API kepada alamat dari mana permintaan anda datang, seperti alamat keluar awam pelayan anda. Meshy kemudiannya menolak kunci itu daripada mana-mana alamat lain, jadi kunci yang disalin menjadi jauh kurang berguna. Kunci tanpa senarai dibenarkan berfungsi daripada mana-mana alamat.
Untuk kunci sepasukan, hanya pentadbir pasukan boleh menukar senarai dibenarkan. Kunci CLI tidak mempunyai satu pun.
Untuk menetapkan senarai dibenarkan, ikuti langkah-langkah ini:
Pada halaman Kunci API, buka menu kunci itu dan klik Manage IP allowlist.
Tambah setiap alamat atau julat. Pilihan: berikan setiap satu nama, contohnya office NAT.
Pilihan: klik Check impact untuk melihat berapa banyak permintaan kunci itu dalam 7 hari lepas yang akan disekat oleh senarai tersebut.
Simpan senarai itu.
Setiap entri ialah satu alamat IPv4 atau IPv6, seperti 203.0.113.5, atau blok CIDR, seperti 203.0.113.0/24. Senarai itu mengikut peraturan berikut:
Satu kunci boleh mempunyai sehingga 50 entri, dan satu nama boleh mempunyai sehingga 60 aksara.
Satu entri mesti berupa alamat awam. Meshy menolak alamat peribadi, gelung balik, dan pautan-setempat, seperti 10.0.0.0/8 atau 127.0.0.1, kerana tiada permintaan sampai ke API daripadanya. Gunakan alamat awam tempat trafik anda keluar.
Satu entri tidak boleh membenarkan setiap alamat, seperti 0.0.0.0/0. Untuk menerima sebarang alamat, buang senarai dibenarkan itu.
Meshy menyimpan blok CIDR sebagai alamat rangkaiannya. Sebagai contoh, 203.0.113.5/24 disimpan sebagai 203.0.113.0/24, iaitu julat yang dikuatkuasakan oleh Meshy.
Dialog itu juga menyenaraikan alamat yang menggunakan kunci itu dalam 7 hari lepas, jadi anda boleh menambahnya terus. Untuk kunci yang sibuk, Meshy mengambil sampel alamat, jadi senarai itu mungkin tidak menunjukkan setiap satu.
Perubahan berkuat kuasa pada permintaan seterusnya, dalam masa seminit paling lama. Selepas anda membuang senarai dibenarkan, mana-mana alamat boleh menggunakan kunci itu semula dalam masa seminit.
Permintaan daripada alamat di luar senarai dibenarkan akan mengembalikan 403 Forbidden dengan kod ralat ip_not_authorized. Mesej ralat itu menamakan alamat yang ditolak, jadi anda boleh menambahnya jika ia milik anda. Permintaan yang ditolak tidak menggunakan kredit atau dikira ke arah had kadar anda.
Ikuti garis panduan ini untuk memastikan data dan permintaan anda selamat, bersama dengan amalan keselamatan pasukan anda sendiri.
Keselamatan Lapisan Pengangkutan
Meshy menyulitkan data anda semasa rehat, dan Meshy API menggunakan TLS untuk menyulitkan data semasa transit. Semua permintaan ke dan dari API berlaku melalui HTTPS, dan permintaan melalui HTTP akan mendapat 301 Moved Permanently.
Elakkan HTTP apabila boleh. Jika anda perlu menghantar permintaan melalui HTTP, beritahu klien HTTP anda untuk mengikut pengalihan ke HTTPS. Contoh berikut menunjukkan caranya:
Follow HTTP to HTTPS redirections
# use `-L` to follow HTTP to HTTPS redirectionscurl-Lhttps://api.meshy.ai/openapi/v1/balance \-H"Authorization: Bearer ${YOUR_API_KEY}"
Pengalihan hanya berfungsi untuk permintaan GET. Klien HTTP menghantar semula POST yang dialihkan sebagai GET tanpa badannya, jadi sentiasa panggil https:// secara terus untuk mencipta tugas.
Keselamatan kunci API
Selepas anda mencipta kunci API, Platform Pembangun tidak menunjukkannya lagi. Simpan di tempat yang selamat, kerana sesiapa yang mempunyai kunci itu boleh memanggil Meshy API sebagai anda. Ahli pasukan Meshy juga tidak boleh melihat atau memulihkan kunci yang telah dibatalkan untuk anda.
Jika anda fikir orang lain mempunyai kunci anda, batalkannya pada halaman Kunci API. Kunci yang dibatalkan tidak lagi berfungsi.
Senarai dibenarkan IP menjadikan kunci yang bocor jauh kurang berguna, tetapi ia tidak menggantikan pembatalan kunci itu. Jika kunci bocor, batalkannya dan cipta satu yang baharu.
Pendedahan keselamatan
Jika anda menemui isu keselamatan dalam Meshy API, hubungi sokongan Meshy. Meshy menghargai pendedahan yang bertanggungjawab dan berusaha sedaya upaya untuk mengiktiraf sumbangan anda.