Использование API Playground

API Playground — удобная среда, где вы можете безопасно тестировать запросы к публичному API Нейро42. Он помогает быстрее разобраться в структуре запросов и проверить работу API без необходимости писать код вручную.

Нейро42 предоставляет вариант интерактивного playgroundа в документации

Playground в документации

Встроенный playground в документации позволяет выполнять реальные API-запросы прямо со страницы описания методов.

Чтобы воспользоваться им, вам потребуется:

Указать базовый URL вашего инстанса Нейро42.
Ввести имя вашей среды или проекта (если используется).
Добавить API-ключ.

Внутри документации Нейро42 использует платформу Scalar для удобного отображения и выполнения запросов.

Важные предупреждения

Используйте тестовый ключ

Все запросы проходят через прокси-серверы Scalar, поэтому:

применяйте тестовый API-ключ,
ограничивайте ключ минимальными правами,
работайте с тестовыми данными, когда это возможно.

Доступ к реальным данным

Playground не эмулирует среду — вы работаете с настоящими объектами:

Можно создавать, изменять и удалять реальные данные.
Рекомендуется заранее подготовить тестовую рабочую область или копию проекта.

Предупреждение о применении иностранного языка

Настоящий мануал включает иностранные термины и выражения, оставленные в оригинале ввиду специфики предметной области и сложности однозначного перевода на русский язык. Данные элементы используются исключительно в целях повышения точности и ясности изложенного материала, поскольку точные аналоги на русском языке либо отсутствуют, либо существенно усложняют восприятие информации пользователями-профессионалами.

Техническая документация не является информацией для широкого круга потребителей. Документация предназначена исключительно для специализированных целей и рассчитана на аудиторию профессионалов, обладающих соответствующей квалификацией и знанием отраслевых стандартов и терминологии. Использование иностранной лексики согласуется с положениями действующего российского законодательства, регулирующего употребление иностранных слов в специальных материалах, направленных на профессиональных пользователей

Данная мера принята для минимизации рисков неправильного толкования ключевых понятий и предотвращения негативных последствий, связанных с некорректностью переводов сложных технических терминов и выражений.

Мы обращаем внимание на тот факт, что наличие иностранного языка в данной документации обусловлено профессиональной необходимостью и соответствует установленным нормам и правилам использования специализированной литературы и документации в Российской Федерации.

Свяжитесь с нами

* нажимая на кнопку, Вы даете согласие на обработку персональных данных