Документация

Документация, которую можно сразу использовать в работе.

Здесь нет мертвых заголовков и фальшивых ссылок. Каждый блок ведет дальше: в сервис, сценарий, доступ или кабинет.

С чего начать

1. Создайте аккаунт и получите токен.

2. Откройте страницу нужного сервиса.

3. Возьмите готовый JSON-блок для Creatium или CreMax.

4. Проверьте вызов на своей задаче.

Токены и доступ

Публичные API уже работают по токену из кабинета.

После регистрации вы получаете токен платформы. Его и нужно передавать в `Authorization: Bearer ...` при вызове `IMG API` и `MAX API` на `helpers.nchub.studio`.

Старт

Сразу после регистрации у токена есть по 10 тестовых запросов на каждый API.

Дальше

Кабинет показывает расход лимита, успешные вызовы, ошибки и последние коды ответов по каждому сервису.

Важно

Для `domain`-подписок дополнительно проверяется домен запроса по `Origin` или `Referer`.

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

Для Creatium и CreMax токен передается в обычном заголовке Authorization.

Ниже рабочий JSON-блок для `IMG API`. Токен храните в своей переменной и подставляйте в заголовок, а не в тело запроса.

IMG API

Готовый JSON-блок сценария

Рабочая основа для вызова через токен из кабинета.

1
{
2
  "scenario_editor": "0.13",
3
  "scenario_blocks": [
4
      {
5
            "key": "img_resize",
6
            "type": "HttpRequest",
7
            "data": {
8
                    "variable": "img_result",
9
                    "url": "\"https://helpers.nchub.studio/api/v1/img/resize\"",
10
                    "method": "POST",
11
                    "content_type": "application/json",
12
                    "headers": [
13
                              {
14
                                          "key": "Authorization",
15
                                          "value": "\"Bearer \" & token"
16
                                        }
17
                            ],
18
                    "body": [],
19
                    "body_expr": "{\n  \"url\": \"https://example.com/image.jpg\",\n  \"sizes\": [200, 400, 800],\n  \"mode\": \"auto\",\n  \"wm\": \"UNIUM\"\n}",
20
                    "timeout": "0"
21
                  },
22
            "logs": []
23
          }
24
    ]
25
}

Коды ответов

200 или 2xx — сервис обработал запрос.

401 — токен не передан или не найден.

403 — лимит исчерпан, сервис не подключен или домен не разрешен.

4xx/5xx от сервиса — запрос дошел до микросервиса, но сам вызов завершился ошибкой валидации или обработки.

Пример ошибки

Как выглядит ответ при остановке по лимиту

Такие ответы тоже попадают в статистику кабинета вместе с кодом и текстом ошибки.

1
{
2
  "error": "Trial limit reached for this service"
3
}

Сервисы и их страницы

У каждого сервиса есть своя рабочая страница.