Документация APIТехническая документация

Документация API по описанию ваших методов

Обычно готово за 15 минутДоработки включеныКонтроль качества
Пакеты
Защита оплатыПодробнее
  • Доработки в рамках пакета бесплатны.
  • Если вы не ответите в течение 3 дней после сдачи, работа будет принята автоматически.

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

Документация API по описанию ваших методов

Пример результата

Пример по пакету «Стандарт»

Документация API: API отслеживания посылок для интернет-магазинов

Быстрый старт

  1. Получите API-ключ в разделе Dashboard → Settings → API keys.
  2. Отправляйте каждый запрос с заголовком Authorization: Bearer <your_key>.
  3. Базовый URL: https://api.trackpoint.example/v1

Получить отправление

GET /shipments/{tracking_number}

Возвращает текущий статус и историю событий одной посылки.

ПараметрГдеОбязателенОписание
tracking_numberpathдаТрек-номер перевозчика, 8–30 символов
langqueryнетЯзык текстов статусов: en, de, fr. По умолчанию en

Пример запроса

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

Пример ответа (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

Ошибки

КодЗначениеЧто делать
401Нет API-ключа или он неверныйПроверьте заголовок Authorization
404Трек-номер не найденПеревозчику нужно до 2 часов, чтобы зарегистрировать новую посылку
429Больше 100 запросов в минутуПодождите время, указанное в заголовке Retry-After

Что сдано

Документация по всем 14 методам в Markdown, готовая для сайта документации заказчика, и список из 3 мест, где API вёл себя не так, как в описаниях; список передан разработчикам.

Заказчик: Trackpoint, стартап, чей REST API позволяет интернет-магазинам показывать статус посылки; разработчики прислали краткие описания 14 методов и набор примеров запросов Задача: быстрый старт и справочник по методам, с которыми разработчик разберётся за 15 минут; ниже фрагмент

Клиент и все данные вымышлены.

Об услуге

Разработчики оценивают API по документации за несколько минут: если не получается авторизация или первый запрос, они уходят. Пишем справочник и руководства по API на основе описаний ваших методов, файла OpenAPI или примеров кода: авторизация, базовые адреса, каждый метод с параметрами, примеры запросов и ответов, коды ошибок, лимиты и пагинация. Быстрый старт показывает первый успешный запрос за несколько шагов.

Что входит

  • Что вы получитеДокументация API в Markdown с блоками кода для ReadMe, GitBook, Docusaurus или вашего репозитория. Пишем по присланным материалам и сами ваш API не вызываем.
  • Быстрый стартОт ключа до первого запроса
  • Справочник методовПараметры, типы, примеры
  • Ошибки и лимитыКоды, значения, повтор запроса
  • Примеры кодаcURL и один язык на ваш выбор
  • Единые терминыТе же названия, что в схеме

Порядок работы

  1. 1
    БрифВы вставляете или прикрепляете методы и примеры
  2. 2
    Структура и текстПишем справочник и руководства
  3. 3
    СдачаВы получаете Markdown для публикации

Что нужно от вас

Описания методов или файл OpenAPI либо Postman, вставленный текстом, данные об авторизации, примеры запросов и ответов, коды ошибок и кто пользуется вашим API.

В брифе мы спросим:

  • Что делает API и кто им пользуется?
  • Как устроена авторизация?
  • На каком языке, кроме cURL, нужны примеры кода?
  • Где будет опубликована документация?

Сравнение пакетов

ПакетыЭконом19 $Стандарт39 $Бизнес79 $
Что входитБыстрый старт и до 5 методовДо 20 методов с руководствамиДо 50 методов, полная документация
Срок1 день3 дня5 дней
Доработки123
Объёмдо 2 000 словдо 6 000 словдо 14 000 слов
Методовдо 5до 20до 50
Языков в примерахcURLcURL + 1cURL + 2
Заказать ЭкономЗаказать СтандартЗаказать Бизнес

Защита оплаты

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

  • Фиксированная ценаЦена пакета не меняется после оплаты.
  • Деньги резервируютсяПри оплате сумма только резервируется. Сервису она переходит, когда вы примете работу.
  • Проверка перед сдачейКаждый результат проходит проверку качества, прежде чем попасть к вам, и вы видите его на странице заказа до приёмки.
  • Бесплатные доработкиПросите изменения в рамках брифа столько раз, сколько предусмотрено пакетом.
  • Приёмка через 3 дняЕсли в течение 3 дней после сдачи вы не примете работу и не попросите изменений, она будет принята автоматически. Если после сдачи вы напишете в чат заказа, заказ подождёт; ответив, мы можем начать отсчёт 3 дней заново и сообщим об этом в чате.
  • Переделка или полный возвратЕсли результат не соответствует брифу и доработки не помогли или срок превышен больше чем вдвое, напишите в чат заказа: мы переделаем работу или полностью вернём деньги.
Как это работает →

Вопросы и ответы

Можете работать по нашей спецификации OpenAPI?

Да, вставьте YAML или JSON в бриф. Мы превратим описания в понятные страницы справочника и восполним пробелы, которые вы укажете.

Вы проверите примеры?

Мы не вызываем ваш API. Примеры строятся по вашим образцам запросов и ответов, поэтому проверьте их перед публикацией.

Пишете документацию для SDK?

Да, если пришлёте сигнатуры методов и примеры использования. Каждый SDK входит в объём пакета.

Не нашли ответ?

Пакеты