Перейти к основному содержимому

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

Добро пожаловать в документацию Matesst. Matesst использует Matesst Turbo JIT (Powered by RunMat) и GNU Octave, чтобы масштабировать ваши алгоритмы на языке .m Script в высокопроизводительные, готовые к использованию RESTful API без необходимости переписывания кода.

Выполните эти 5 шагов, чтобы запустить свой первый API.

1. Создание приложения (APP)​

Войдите в Консоль Matesst. Перейдите в раздел Applications и нажмите Create APP.

Создать приложение

2. Подготовка и загрузка исходного кода​

Сначала напишите свой собственный алгоритм. Имя функции в вашем коде будет точкой входа в API. Например, создайте файл my_math.m:

% Файл: my_math.m
% Это входная функция вашего алгоритма.
% Имя файла (без .m) становится конечной точкой API.

function [sum_val, prod_val] = my_math(a, b)
    % Простой алгоритм, вычисляющий сумму и произведение
    sum_val = a + b;
    prod_val = a * b;
end

Заархивируйте эти файлы напрямую в ZIP (например, my_math.zip). Matesst полностью поддерживает сложные структуры проектов; вы можете свободно организовывать свои скрипты в подпапках внутри ZIP-архива.

Затем перейдите в раздел My Apps, выберите свое приложение и загрузите ZIP-архив. Matesst автоматически проанализирует точки входа.

Загрузить ZIP

3. Управление и авторизация​

На странице сведений о приложении вы можете отслеживать статус развертывания. Каждое приложение имеет свой уникальный API Key. Храните этот ключ в безопасности, так как он является учетными данными для вызова API этого конкретного приложения.

Управление приложениями

4. Биллинг и активация карты​

Matesst использует систему кредитов. Вы можете просмотреть свой Баланс (Balance) на странице Orders. Если у вас есть секретный код карты, введите номер карты и пароль, чтобы мгновенно получить Кредиты (Credits).

Биллинг

5. Мониторинг логов вызовов​

Подробную историю выполнения можно просмотреть в разделе Logs. Оплата основана на времени вычислений: 1 кредит потребляется в секунду (1 Credit/s). Это поможет вам контролировать расходы в режиме реального времени.

Логи вызовов

Ваш первый запрос​

После активации вызовите свое приложение через POST-запрос. Ниже приведен пример вызова функции my_math, определенной выше. Не забудьте использовать API Key вашего приложения:

curl -X POST https://api.matesst.com/api/v2/my_math \
  -H "Authorization: Bearer YOUR_APP_SPECIFIC_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "params": [10, 20],
    "nargout": 2
  }'

Правила упаковки результатов (Results Wrapping)​

Структура поля results зависит от nargout и типа возвращаемых данных:

  • Число при nargout = 1: results возвращает число напрямую.
  • В остальных случаях: results всегда упаковывается в массив. Например, если функция возвращает массив [1, 2, 3] при nargout = 1, ответ будет [[1, 2, 3]].

Пример: Одиночное число (nargout = 1)​

{
  "results": 30,
  "status": "success"
}

Пример: Несколько выходов (nargout = 2)​

{
  "results": [30, 200],
  "status": "success"
}

Пример: Выход в виде массива (nargout = 1)​

{
  "results": [[1, 2, 3]],
  "status": "success"
}

Узнайте больше в Справочнике API.