Описание проекта
У нашей компании есть REST API, которым пользуются партнёры-разработчики для интеграции со своими сервисами, но документация к нему давно устарела: часть эндпоинтов описана в старых заметках, часть вообще нигде не зафиксирована, и партнёры регулярно пишут в поддержку с одними и теми же вопросами. Нужен технический писатель, который приведёт всё в порядок и сделает документацию, по которой разработчик сможет разобраться самостоятельно, без переписки с нашей командой.
Задача — описать каждый метод API: что он делает, какие параметры принимает (обязательные и необязательные, с типами и значениями по умолчанию), как устроена авторизация, какие коды ошибок возвращаются и что они означают. К каждому методу нужны примеры запроса и ответа в формате JSON, желательно на реальных, а не абстрактных данных. Отдельная часть работы — интерактивная страница, где партнёр сможет подставить свой ключ, отправить тестовый запрос прямо из браузера и увидеть настоящий ответ сервера.
Мы дадим доступ к тестовому окружению, поделимся черновыми заметками разработчиков и организуем созвон с бэкенд-командой, если что-то будет непонятно по логике методов. Ожидаем опыт написания технической документации к API, понимание REST и JSON, знакомство со схемами авторизации через ключи и токены. Приветствуются примеры готовых работ и предполагаемые сроки.
Что нужно в результате:
— структурированное описание всех методов и параметров
— примеры запросов и ответов по каждому методу
— рабочая интерактивная страница для тестирования
— краткое руководство для новых партнёров
Задача — описать каждый метод API: что он делает, какие параметры принимает (обязательные и необязательные, с типами и значениями по умолчанию), как устроена авторизация, какие коды ошибок возвращаются и что они означают. К каждому методу нужны примеры запроса и ответа в формате JSON, желательно на реальных, а не абстрактных данных. Отдельная часть работы — интерактивная страница, где партнёр сможет подставить свой ключ, отправить тестовый запрос прямо из браузера и увидеть настоящий ответ сервера.
Мы дадим доступ к тестовому окружению, поделимся черновыми заметками разработчиков и организуем созвон с бэкенд-командой, если что-то будет непонятно по логике методов. Ожидаем опыт написания технической документации к API, понимание REST и JSON, знакомство со схемами авторизации через ключи и токены. Приветствуются примеры готовых работ и предполагаемые сроки.
Что нужно в результате:
— структурированное описание всех методов и параметров
— примеры запросов и ответов по каждому методу
— рабочая интерактивная страница для тестирования
— краткое руководство для новых партнёров
Тексты и Перевод Наличные, Банковский перевод
