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

Використання 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-ключа з опціональним полем місячного ліміту кредитів

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

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

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

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

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

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Префікс Bearer у значенні заголовка є обов'язковим для програмної взаємодії з Meshy API. Дізнатися більше про це можна за посиланням IETF RFC 6750

Security

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

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

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

Follow HTTP to HTTPS redirections

# use `-L` to follow HTTP to HTTPS redirections
curl -L -X 'POST' \
  https://api.meshy.ai/openapi/v1/text-to-texture

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

Зверніть увагу, що навіть співробітники команди Meshy не можуть переглянути чи відновити для вас відкликані API-ключі!

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

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

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