Платформа для разработчиков

Платформа для разработчиков — это место, где вы запускаете, отслеживаете и настраиваете всё, что связано с интеграцией Meshy API — Playground для опробования эндпоинтов без написания кода, панели мониторинга, охватывающие каждый запрос API на вашем аккаунте, а также управление API-ключами и webhook.

Аккаунты уровня Free могут опробовать Playground только на эндпоинте «Изображение в 3D», используя выделенный встроенный ключ для тестирования — аккаунты Free не могут создавать или управлять собственными API-ключами и не имеют доступа к панели мониторинга Usage и Request Logs. Планы Pro, Premium, Ultra, Studio и Enterprise получают доступ ко всем эндпоинтам Playground, полный доступ к панели мониторинга Usage и Request Logs, а также к собственным API-ключам.

Обзор

Откройте Платформу для разработчиков из веб-приложения. Её боковая панель организована следующим образом:

  • Build — Playground, для интерактивного опробования эндпоинтов.
  • Monitor — панель мониторинга Usage и Request Logs.
  • Configure — API-ключи и Webhooks.

Сама страница Overview проведёт новые аккаунты через три шага ниже (создание ключа, пробный запрос в Playground, проверка результата в Request Logs), а затем покажет снимок активности вашего аккаунта за 7 дней и последние записи из журнала изменений Meshy API.

Страница Overview Платформы для разработчиков, показывающая карточку из трёх шагов для начала работы, снимок использования за 7 дней и последние обновления журнала изменений Meshy API

Новичок в API? Начните с раздела Быстрый старт.

Playground

Playground — это интерактивная консоль для опробования эндпоинтов без написания какого-либо кода. Выберите эндпоинт, заполните параметры с помощью встроенных подсказок и отправьте запрос — задачи проходят через тот же асинхронный конвейер, что и API, поэтому вы увидите, как задача переходит из состояния PENDING в SUCCEEDED, и сможете изучить полный ответ и полученную модель.

Playground, выполняющий запрос «Изображение в 3D», с живым предпросмотром модели рядом с вкладками Preview, Request и Response

Пока задача выполняется, вкладка Preview транслирует обновления статуса в реальном времени — опрос не требуется.

Журнал вкладки Preview в Playground, транслирующий обновления статуса в реальном времени во время выполнения задачи

Переключитесь на вкладку Request, чтобы получить готовый к запуску фрагмент кода на cURL, Python или JavaScript, или на вкладку Response, чтобы изучить полный JSON — именно здесь Playground оправдывает себя по сравнению с рабочей областью веб-приложения: каждый созданный вами запрос находится в одном шаге копирования-вставки от запуска в вашем собственном коде.

Request and Response tabs
The same task, viewed two ways: the equivalent cURL request, and the raw JSON response.
The Playground's Request tab showing the equivalent cURL command for the current request
Request
The Playground's Response tab showing the raw JSON response
Response

Панель мониторинга Usage

Панель мониторинга Usage визуализирует всю активность API вашего аккаунта — каждый запрос, будь то выполненный напрямую через API или из Playground. Она показывает процент успешных генераций, общее количество запросов, среднее время обработки и потраченные кредиты, а также объём запросов во времени и разбивку показателя успешности и задержки по эндпоинтам.

Панель мониторинга Usage, показывающая процент успешных генераций, объём запросов во времени, а также показатель успешности и задержку в разбивке по эндпоинтам

Request Logs

Request Logs содержит список каждой задачи API на вашем аккаунте — как прямых вызовов API, так и запросов из Playground — с указанием статуса, времени выполнения и API-ключа, с помощью которого был сделан запрос. Выберите задачу, чтобы увидеть её полные входные и выходные данные, тело запроса и потраченные кредиты — это полезно для отладки конкретного вызова без повторного запроса к API — или перейдите прямо к ней в Playground. Используйте кнопку Export CSV, чтобы выгрузить весь список для отчётности или сверки.

Request Logs с выбранной задачей, статус которой, предпросмотр входных/выходных данных и тело запроса показаны на панели детализации — выделены кнопки Export CSV и Open in Playground

Управление API

  • API-ключи — создавайте, называйте и отзывайте ключи, устанавливайте месячный лимит кредитов для каждого из них и просматривайте статистику использования каждого ключа.
  • Webhooks — получайте обновления в реальном времени при изменении статуса ваших задач API, вместо опроса. Инструкции по настройке, требования к доставке и примеры полезной нагрузки см. в руководстве Webhooks.

Обратная связь

На каждой странице Платформы для разработчиков в правом нижнем углу есть кнопка Feedback — используйте её, чтобы сообщить об ошибке, предложить функцию или рассказать, что вызывает затруднения. Мы читаем каждое обращение.

Аутентификация и кредиты

Запросы авторизуются с помощью API-ключа, передаваемого в заголовке Authorization: Bearer, точно так же, как при прямом вызове API. Playground работает с вашим собственным аккаунтом, поэтому каждый запрос расходует кредиты вашего плана и учитывается в лимитах частоты запросов, точно так же, как и любой другой вызов API. Подробнее о форматах ключей и безопасности см. в руководстве Аутентификация.