Autentikasi
Menggunakan Meshy API memerlukan autentikasi. Panduan ini akan menunjukkan cara membuat akun dan kunci API.
API Keys
Membuat Akun Meshy
Meshy API mengharuskan Anda memiliki akun Meshy untuk membuat dan mengelola kunci API. Jika sebuah permintaan dibuat ke API tanpa kunci API, API akan merespons dengan error kredensial tidak valid.
Anda dapat membuat akun Meshy dengan mengunjungi situs resmi Meshy dan mendaftar.
Membuat Kunci API
Setelah Anda membuat akun Meshy, Anda dapat membuat kunci API di halaman API Keys pada Developer Platform.
Anda dapat membuat beberapa kunci API untuk tujuan yang berbeda. Misalnya, Anda dapat membuat satu kunci API untuk aplikasi iOS Anda dan satu lagi untuk aplikasi web Anda. Penggunaan setiap kunci API dilacak secara terpisah, dan Anda dapat mencabutnya kapan saja.
Anda juga dapat menetapkan batas kredit bulanan pada kunci mana pun, yang membatasi seberapa banyak kunci tersebut dapat digunakan terlepas dari penggunaan akun Anda secara keseluruhan — berguna untuk membatasi kunci yang Anda berikan kepada kontraktor atau lingkungan tertentu.
Untuk membuat kunci API, klik tombol Create API Key pada halaman API, lalu masukkan nama untuk kunci API Anda.
Setelah Anda membuat kunci API, nilai kunci API akan ditampilkan. Anda dapat menyalin nilai kunci API tersebut dan menyimpannya di lokasi yang aman.
Anda tidak akan dapat melihat nilai kunci API ini lagi.
Menggunakan Kunci API
Setelah Anda membuat kunci API, Anda dapat menggunakannya untuk mengautentikasi permintaan Anda ke
Meshy API. Anda dapat meneruskan kunci API Anda ke API melalui header Authorization,
contoh header ditunjukkan di bawah ini.
{
"Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}
Prefiks Bearer pada nilai header bersifat wajib untuk berinteraksi dengan Meshy API secara programatik.
Anda dapat mempelajari lebih lanjut tentangnya di IETF RFC 6750
Security
Kami sangat serius dalam hal keamanan di Meshy, dan kami bekerja keras untuk memastikan Meshy API aman. Kami berharap data Anda dan data pengguna Anda aman bersama kami. Berikut beberapa panduan tingkat tinggi untuk membantu Anda menjaga keamanan data dan permintaan Anda saat menggunakan Meshy API, namun pastikan juga untuk mengikuti panduan yang diterapkan di tim atau tempat kerja Anda.
Transport Layer Security
Meskipun data Anda dienkripsi saat disimpan (at rest) setelah tersimpan di Meshy, Meshy API menggunakan dan menerapkan TLS,
untuk mengenkripsi data saat transit. Ini berarti semua permintaan ke dan dari Meshy API dikirim melalui HTTPS, dan permintaan apa pun yang dibuat melalui HTTP akan mendapatkan kode status 301 Moved Permanently. Meskipun tidak disarankan,
dalam beberapa kasus, jika Anda harus berkomunikasi melalui HTTP, Anda perlu secara eksplisit memberi tahu klien HTTP Anda untuk mengikuti pengalihan HTTP ke HTTPS. Berikut beberapa contohnya:
Follow HTTP to HTTPS redirections
# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Pengalihan hanya berfungsi untuk permintaan GET: klien HTTP mengirim ulang POST yang dialihkan sebagai GET tanpa isinya (body), jadi selalu panggil https:// secara langsung saat membuat tugas.
API Key Safety
Harap diperhatikan bahwa bahkan tim Meshy pun tidak dapat melihat atau memulihkan kunci API yang telah dicabut untuk Anda!
Setelah dibuat, kunci API tidak lagi terlihat di dasbor, jadi harap unduh dan simpan dengan aman dan terjaga, karena siapa pun yang memperolehnya dapat menggunakannya untuk berkomunikasi dengan Meshy API atas nama Anda. Jika Anda yakin kunci API Anda telah disusupi, Anda dapat mencabutnya kapan saja dari dasbor, setelah dicabut, kunci tersebut tidak akan berlaku lagi.
Security Disclosure
Jika Anda yakin telah menemukan masalah keamanan pada Meshy API, silakan hubungi kami. Kami menghargai pengungkapan yang bertanggung jawab dan akan berusaha sebaik mungkin untuk mengakui kontribusi Anda.