Аутентификация

Для использования Meshy API требуется аутентификация. Это руководство покажет вам, как создать учётную запись и API-ключи.

API-ключи

Создание учётной записи 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, пожалуйста, свяжитесь с нами. Мы ценим ваш ответственный подход к раскрытию информации и приложим все усилия, чтобы отметить ваш вклад.