Автентифікація

Для використання Meshy API потрібна автентифікація. Цей посібник покаже вам, як створити обліковий запис та API-ключі.

API Keys

Створення облікового запису Meshy

Meshy API вимагає наявності облікового запису Meshy для створення та керування API-ключами. Якщо запит до API надсилається без API-ключа, API відповість помилкою недійсних облікових даних.

Ви можете створити обліковий запис Meshy, відвідавши офіційний вебсайт Meshy та зареєструвавшись.

Створення API-ключів

Після того як ви створили обліковий запис Meshy, ви можете створювати API-ключі на сторінці API Keys у Developer Platform.

Ви можете створити кілька API-ключів для різних цілей. Наприклад, ви можете створити один API-ключ для вашого iOS-застосунку та інший для веб-застосунку. Використання кожного API-ключа відстежується окремо, і ви можете відкликати їх у будь-який час.

Ви також можете встановити місячний ліміт кредитів для будь-якого ключа, обмежуючи, скільки він може витратити незалежно від загального використання вашого облікового запису — це корисно для обмеження ключа, який ви передаєте підряднику або використовуєте в конкретному середовищі.

Щоб створити API-ключ, натисніть кнопку Create API Key на сторінці API, а потім введіть назву для вашого API-ключа.

Після створення API-ключа вам буде показано значення API-ключа. Ви можете скопіювати значення API-ключа та зберегти його в надійному місці.

Ви більше не зможете побачити це значення API-ключа знову.

Використання API-ключів

Після того як ви створили API-ключ, ви можете використовувати його для автентифікації ваших запитів до Meshy API. Ви можете передати ваш API-ключ до API в заголовку Authorization, приклад заголовка показано нижче.

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Безпека

Ми дуже серйозно ставимося до безпеки в Meshy і наполегливо працюємо над тим, щоб Meshy API був безпечним. Ми сподіваємося, що ваші дані та дані ваших користувачів у безпеці з нами. Нижче наведено кілька рекомендацій загального рівня, які допоможуть вам зберегти ваші дані та запити в безпеці під час використання Meshy API, але також обов'язково дотримуйтесь правил, прийнятих у вашій команді чи на робочому місці.

Безпека транспортного рівня

Хоча ваші дані шифруються в стані спокою після збереження в Meshy, Meshy API використовує та забезпечує TLS, для шифрування даних під час передачі. Це означає, що всі запити до та від Meshy API надсилаються через HTTPS, і будь-який запит, зроблений через HTTP, отримає код стану 301 Moved Permanently. Хоча це не рекомендується, у деяких випадках, якщо вам потрібно звертатися через HTTP, вам потрібно явно вказати вашому HTTP-клієнту слідувати перенаправленням з HTTP на HTTPS. Ось кілька прикладів:

# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Перенаправлення працюють лише для запитів GET: HTTP-клієнти повторно надсилають перенаправлений POST як GET без його тіла, тому завжди звертайтеся безпосередньо до https:// під час створення завдань.

Безпека API-ключів

Після створення API-ключі більше не відображаються в панелі керування, тому, будь ласка, завантажте його та зберігайте в безпечному та надійному місці, оскільки будь-хто, хто отримає його, зможе використовувати його для взаємодії з Meshy API від вашого імені. Якщо ви вважаєте, що ваш API-ключ був скомпрометований, ви можете відкликати його в будь-який час з панелі керування, після відкликання він більше не буде дійсним.

Розкриття інформації про безпеку

Якщо ви вважаєте, що виявили проблему безпеки в Meshy API, будь ласка, зв'яжіться з нами. Ми цінуємо вашу відповідальну позицію щодо розкриття інформації та докладемо всіх зусиль, щоб визнати ваш внесок.