Для работы с Fasttrack API вам понадобится уникальный access_token, которым необходимо передавать в заголовке для каждого запроса. Следуйте инструкции ниже, чтобы получить ключ доступа для вашего проекта:
Важно! Временно, приложения клиентов для использования API Fasttrack, регистрируются вручную, через менеджеров проекта.
Шаг 1: Подготовить redirect_uri
redirect_uri — это URL, на который сервер перенаправит вас после успешной авторизации, передавая временный код (code). Этот код затем используется приложением для обмена на ключ доступа (access_token).
Шаг 2: Зарегистрировать приложение
Сообщите менеджеру о том, что планируете использовать Fasttrack API и предоставьте redirect_uri для регистрации вашего приложения.
Данные о приложении, которые вы получите:
client_id
Идентификатор вашего приложения.
client_secret
Защищённый ключ вашего приложения
Внимание! Параметр client_secret используется для идентификации и подтверждения подлинности вашего приложения в процессе OAuth-авторизации. Этот параметр является конфиденциальным и должен защищаться так же строго, как и пароли.
Перейдите по ссылке. Вы попадете на страницу со списком доступных проеков (их может быть несколько). Выберите проект для которого планируете получить access_token.
Браузер переадресует вас обратно на URL, указанный в параметре redirect_uri с добавлением параметров state и временного кода авторизации (code).
Шаг 5: Получитьaccess_token
POST https://dashboard.fstrk.io/api/partners/oauth/
Метод для получения access_token в рамках OAuth-авторизации.
При успешном выполнении запроса API возвращает код ответа 200 и JSON-объект с параметром access_token.
200
{
"access_token": "string"
}
Формат запросов
API работает по протоколу HTTP(S) и поддерживает методы REST (Representational State Transfer), такие как GET, POST, PUT, PATCH и DELETE. Каждый запрос имеет стандартный формат и требует обязательного использования корректных заголовков и параметров.
Базовый URL
https://dashboard.fstrk.io/api/partners/
Заголовки
Каждый запрос к API Fasttrack требует заголовок Authorization для подтверждения прав доступа. Без этого заголовка сервер не обработает запрос и вернет ошибку.
Authorization: Bearer { access_token }
Для корректной работы с API Fasttrack запросы, которые передают данные, должны содержать заголовок Content-Type. Он указывает, что данные в запросе отправляются в формате JSON.
Content-Type: application/json
Также рекомендуется указывать заголовок Accept, чтобы явно запросить от сервера ответы в формате JSON. Это обеспечивает корректное восприятие данных на стороне клиента.
Accept: application/json
Методы API
Список методов:
GET/mailings/ – список рассылок
POST/mailings/ – создание рассылки
GET/mailings/{ uuid }/ – информация о рассылке
POST/mailings/{ uuid }/calculate/ – подсчет статистики
POST/mailings/{ uuid }/stop/ – остановка рассылки
Для тестирования, необходимо авторизоваться в Fasttrack.
Создание рассылки
POST /mailings/
Универсальный метод для создания новой рассылки.
Заголовки
Content-Type
application/json
Authorization
Bearer { access_token }
Тело запроса application/json
name(string)* – название рассылки.
Пример: "Моя первая WA-рассылка"
content_type(string) – тип контента.
Значение: "WHATSAPP_TEMPLATE"
phone_numbers_file(string) – Ссылка на файл со списком телефонов.
template_whatsapp(string) – ID согласованного WhatsApp-шаблона.
Пример: "name_of_approved_template"
template_variable(object) – Список заполненных переменных для шаблона.
planned_at(string) – дата и время запуска для отложенных рассылок.
Формат: ISO 8601
Пример: "2024-09-16T19:41:02.768Z"
regular_cron(string) – расписание для регулярных рассылок.
Формат: CRON
Пример: "00 12 * * *" (рассылка в 12:00 каждый день).
origin(string) – признак источника рассылки.
Значения: "chat_center""system"
По умолчанию: "system"
Если указать chat_center, то рассылка будет отправлена всем пользователям, в том числе тем, у кого в момент рассылки открыта сессия с оператором.
Примеры запросов
Ниже приведены примеры запросов, оформленные в формате cURL. Они демонстрируют различные сценарии использования и настройки параметров для создания рассылок.
