Опис проєкту
ПерекладНаша компанія має REST API, яким користуються партнери-розробники для інтеграції власних сервісів, але документація до нього давно застаріла: частина методів описана в старих нотатках, частина взагалі ніде не зафіксована, і партнери постійно звертаються в підтримку з одними й тими самими питаннями. Потрібен технічний письменник, який приведе все до ладу і підготує документацію, за якою розробник зможе розібратися самостійно, без листування з нашою командою.
Завдання — описати кожен метод API: що він робить, які параметри приймає (обов'язкові й необов'язкові, з типами та значеннями за замовчуванням), як влаштована авторизація, які коди помилок повертаються і що вони означають. До кожного методу потрібні приклади запиту та відповіді у форматі JSON, бажано на реалістичних, а не абстрактних даних. Окрема частина роботи — інтерактивна сторінка, де партнер зможе підставити свій ключ, надіслати тестовий запит прямо з браузера і побачити справжню відповідь сервера.
Ми надамо доступ до тестового середовища, поділимося чорновими нотатками розробників і організуємо дзвінок із бекенд-командою, якщо щось буде незрозуміло щодо логіки методів. Очікуємо досвід написання технічної документації до API, розуміння REST і JSON, знайомство зі схемами авторизації через ключі та токени. Вітаються приклади готових робіт і орієнтовні терміни.
Що потрібно в результаті:
— структурований опис усіх методів і параметрів
— приклади запитів і відповідей для кожного методу
— робоча інтерактивна сторінка для тестування
— короткий гід для нових партнерів
Завдання — описати кожен метод API: що він робить, які параметри приймає (обов'язкові й необов'язкові, з типами та значеннями за замовчуванням), як влаштована авторизація, які коди помилок повертаються і що вони означають. До кожного методу потрібні приклади запиту та відповіді у форматі JSON, бажано на реалістичних, а не абстрактних даних. Окрема частина роботи — інтерактивна сторінка, де партнер зможе підставити свій ключ, надіслати тестовий запит прямо з браузера і побачити справжню відповідь сервера.
Ми надамо доступ до тестового середовища, поділимося чорновими нотатками розробників і організуємо дзвінок із бекенд-командою, якщо щось буде незрозуміло щодо логіки методів. Очікуємо досвід написання технічної документації до API, розуміння REST і JSON, знайомство зі схемами авторизації через ключі та токени. Вітаються приклади готових робіт і орієнтовні терміни.
Що потрібно в результаті:
— структурований опис усіх методів і параметрів
— приклади запитів і відповідей для кожного методу
— робоча інтерактивна сторінка для тестування
— короткий гід для нових партнерів
Тексти та Переклад Готівка, Банківський переказ
