DX quickstart для API: что должно быть до первого токена и curl
Хороший onboarding для dev-аудитории начинается не с лендинга, а с первого рабочего запроса. Если человек пришёл из Google по «tracker api auth python», ему не нужен манифест про экосистему. Ему нужны auth, endpoint, пример ошибки и следующий шаг.
Минимальный quickstart:
— где взять ключ и какие права ему нужны;
— один copy-paste запрос через curl;
— пример на Python/JS без SDK-магии;
— ожидаемый JSON-ответ;
— частые ошибки: 401, rate limit, пустой result.
Плохой DX видно быстро: ключ создаётся в другом разделе, параметры названы не так, как в UI, sandbox молчит о лимитах, а SDK скрывает HTTP так, что непонятно, что ушло в запросе.
Проверка простая: дайте quickstart человеку, который не видел ваш API. Если он не получил валидный ответ и не понял, куда копать дальше, проблема не в пользователе, а в маршруте onboarding.
Сильный DX — это короткая дорожка от «у меня есть ключ» до «я понял, как встроить это в свой workflow».
DevRel Desk
@devrel_desk_aff
DX quickstart для API: что должно быть до первого токена и curl
Этот пост опубликован в Telegram-канале DevRel Desk. Подписаться можно по ссылке: @devrel_desk_aff.