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

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

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

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

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

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

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

Регламенты: открытие и закрытие небольшой кофейни

Регламент Р-02. Закрытие кофейни

ЦельОставить кофейню чистой, безопасной и готовой к утренней смене
Кто выполняетБариста закрывающей смены, проверяет старший смены
КогдаНачало в 21:30, двери закрываются в 22:00, всё готово к 22:45
Что нужноБланк чек-листа закрытия, ключ от кассы, ящик с моющими, синие салфетки

Перед началом

Внимание: не выключайте общий рубильник в щитке. Холодильники и сигнализация подключены к нему же.

Порядок действий

  1. В 21:30 переверните табличку на двери на «Последний заказ». Гости, которые уже внутри, могут остаться до 22:00.
  2. Включите на кофемашине режим промывки. Нажмите и держите кнопку с чашкой 5 секунд. Что вы увидите: на экране мигает «ПРОМЫВКА», через обе группы около 2 минут идёт горячая вода.
  3. Снимите холдеры и замочите в чёрном контейнере с одной чистящей таблеткой на 20 минут.
  4. Перенесите десерты и сэндвичи в дальний холодильник. На всё вскрытое сегодня наклейте стикер с датой и «Реализовать до завтра».
  5. Запишите температуру холодильников в журнал. Что вы увидите: от +1 до +5 °C. Если выше +5 °C, сначала перейдите к шагу 12.
  6. В 22:00 закройте входную дверь и переверните табличку на «Закрыто».
  7. Закройте смену на кассе. Меню → «Закрытие смены» → «Z-отчёт». Что вы увидите: печатается отчёт с выручкой за день. Наличные у стойки не пересчитывайте — унесите ящик в подсобку.

(Шаги 8–14: полы, мусор, сигнализация и записка для утренней смены.)

Если что-то пошло не так

ПроблемаЧто делать
В холодильнике выше +5 °CПереложите продукты во второй холодильник, запишите время и температуру, напишите старшему смены
Z-отчёт не печатаетсяЗамените чековую ленту; если не помогло — перепишите сумму с экрана и сфотографируйте его
Сигнализация не встаёт на охрануПроверьте, плотно ли закрыта задняя дверь: при открытой двери охрана не включается

Подпись

Бариста: ФИО, время. Старший смены: подпись.

Дата последней редакции: [дата]. Пересмотреть при замене кофемашины или кассы.

Заказчик: кофейня «Колокольчик» в Твери, 22 посадочных места, 7 сотрудников в сменном графике Исходники: голосовые заметки владелицы, рукописный чек-лист и 9 фото стойки, кофемашины и экрана кассы Результат: 6 регламентов (4 600 слов): открытие, закрытие, работа с наличными, журнал температуры холодильников, чистка кофемашины, работа с жалобой гостя. Ниже — фрагмент регламента закрытия.

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

Об услуге

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

Что входит

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

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

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

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

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

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

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

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

ПакетыЭкономБыстрый старт и до 5 методов19 $СтандартДо 20 методов с руководствами39 $БизнесДо 50 методов, полная документация79 $
Срок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 входит в объём пакета.

Пакеты
Заказать · 39 $· 3 дня