Quick Start

Обратите внимание: для работы с новой версией API, необходимо использовать новые токены. Прежний ключ от предыдущей версии здесь работать не будет.

Получить токен доступа

Для получения токена доступа, вам необходимо перейти в администрирование системы в раздел API https://admin.myfreshcloud.com/settings-api

Возьмите на заметку: необходимо обладать правами доступа к разделу API. Каждый сформированный токен хранится в специальном реестре. Если что-то подойдёт не так, в любой момент можно выключить токен, и весь трафик с его использования будет остановлен.

Метод авторизации

Bearer Token ⚡️ Content-Type : application/json

--header 'Authorization: Bearer XXXXXXX.XXXXXXXX.XXXXXXX'

Первый запрос и первый ответ

Обратите внимание: для проверки запросов можно использовать PostMan или другой удобный для вас инструмент работы с API

Для начала давайте получим ответ Welcome! ⚡️Это запрос должен содержать токен авторизации

Welcome!

GET https://do.myfreshcloud.com/welcome/first

Headers

NameTypeDescription

Content-Type

String

application/json

Authorization*

String

Bearer XXXXX.XXXXX.XXXXX

{
    "status": "success",
    "error": null,
    "code": null,
    "rows": 1,
    "pages": 1,
    "page": 1,
    "value": "Welcome! And let's continue: https://apidoc.myfreshcloud.com/"
}
curl --location --request GET 'https://do.myfreshcloud.com/welcome/first' \
--header 'Authorization: Bearer XXXXXXX.XXXXXXX.XXXXXX'

Объект ответа


{
    "status": "success",
    "error": null,
    "code": null,
    "rows": 1,
    "pages": 1,
    "page": 1,
    "value": "Welcome! And let's continue: https://apidoc.myfreshcloud.com/"
}

//  status - статус выполнения [success] [error]
//  error - текст ошибки, при наличии
//  code - код ошибки при наличии
//  rows - количество строк 
//  pages - количество страниц
//  page - текущая страница
//  value - запрошенные данные, обычно в формате JSON

Last updated