// documentation

Обзор будущего API

Принципы и структура публичного API, которое будет добавлено в следующих версиях сервиса.

API Preview: публичный контракт ещё не опубликован

Статус API

Публичный API находится в разработке. Этот раздел показывает будущую структуру документации и не описывает доступный для вызова контракт.

Текущие внутренние маршруты веб-интерфейса не являются публичным API. Они используют сессионную авторизацию, внутренние имена действий и могут меняться вместе с фронтендом.

Принципы будущего контракта

Публичный интерфейс будет строиться вокруг стабильных ресурсов, предсказуемых HTTP-методов, JSON-ответов и версионирования. Документация должна оставаться единым источником сведений о параметрах, ответах, ошибках и изменениях.

Предварительные ресурсы

В первую очередь рассматриваются проекты, товары, склады, отчёты, задачи и контакты. Итоговый состав будет определён после проектирования внешнего контура и проверки сценариев интеграторов.

Что можно сделать сейчас

Изучить модель данных продукта, определить нужные сценарии и подготовить интеграцию к работе с API-ключами, пагинацией, ограничениями запросов и webhook-событиями.

GET/v1/projects

curl --request GET \
  "$MARKETHOUSE_API_URL/v1/projects?limit=20" \
  --header "Authorization: Bearer $MARKETHOUSE_API_KEY"

200 OKПример ответа

{
  "data": [
    {
      "id": "project_demo",
      "name": "Основной проект",
      "status": "active"
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}