Обзор

Узнайте как использовать SalesKit Rest Api.

Здесь описываются общие сведения о способах получения и передачи информации с помощью rest api.

Все примеры в этой документации будут на языке PHP с использованием Laravel >=9. Ничего страшного, если Вы используете другой язык программирования или другой фрэймворк. Все примеры будут работать и у Вас.

Если у Вас возникли проблемы или есть предложения, можете написать нам на почту hello@saleskit.biz и мы с радостью Вам поможем.

Запросы к Rest Api

Весь доступ к АПИ осуществляется через HTTPS и осуществляется из базового URL https://api.saleskit.biz/openapi. Все данные отправляются и принимаются в формате JSON.

Версионность

При обращении к API базовый URL для API будет следующим: https://api.saleskit.biz/openapi/v2

Методы запросовк API

Rest API поддерживает 4 метода запросов:

1. GET - В основном используется для получения информации.

2. POST - В основном используется для создания сущностей и в некоторых случаях для изменения.

3. PUT - Используется для изменения сущностей.

4. DELETE - Используется для удаления сущностей.

Чтобы подобрать правильный метод запроса, необходимо смотреть необходимый метод запроса непосредственно в описании конкретного метода

Авторизация (oAuth 2.0)

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

Access-Token - Токен, необходим для каждого запроса. Имеет срок жизни 48 часов.

Refresh-Token - Токен, необходим для получения нового Access-Token после того как срок жизни последнего истечет. Имеет срок жизни 90 суток.

Более подробно с авторизацией для работы с API Вы можете ознакомиться в разделе "Авторизация"

Перейти

Webhooks

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

Перейти