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

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

API-ключі

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

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

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

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

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

Ви можете створити кілька 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"
}

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

Безпека

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

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

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

Слідувати перенаправленням з HTTP на HTTPS

# 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, будь ласка, зв'яжіться з нами. Ми цінуємо ваше відповідальне розкриття і докладемо всіх зусиль, щоб визнати ваші внески.