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

API Sensei

Текущая версия — 1.
Base URL API Sensei: https://api.sensei.plus/v1/

Формат ответов: json

Каждый ответ всегда содержит три параметра:
status: {статус ответа}
message: {текст ответа}
data: {данные ответа}

Ниже будут представлены примеры обращения к API на js.
По аналогии можно использовать любой язык программирования, отправляя GET и POST запросы.

Статусы ответов
200: успешно

Авторизация

Авторизация осуществляется по API-данным от аккаунта amoCRM, переданным в заголовке запроса.

X-Domain — домен amoCRM
X-Login — логин
X-Api-Key — API-ключ

Процесс

Получение списка процессов
url: process/list/
method: GET

Пример запроса на js. Для теста запустите запрос в консоли браузера в amoCRM.

var sensei_api = function() {
        var baseUrl = 'https://api.sensei.plus/v1/';
        var self = this;
        this.send = function (url, method, data) {
            data = data || {};
            headers = {};
            headers.domain = AMOCRM.widgets.system.domain;
            headers.api_key = AMOCRM.widgets.system.amohash;
            headers.login = AMOCRM.widgets.system.amouser;
            var params = {
                url: baseUrl + url,
                data: data,
                method: method,
                dataType: 'json',
                headers: {
                    'X-Domain': headers.domain,
                    'X-Api-Key': headers.api_key,
                    'X-Login': headers.login,
                },
                success: function(data) {
                    console.log(data);                
            	}
	     };
            return new $.ajax(params);
        };
        this.getProcesses = function () {
            self.send('process/list', 'GET');
        };
};
api = new sensei_api;
api.getProcesses();

Пример ответа

[
   [status] => 200
   [message] => Success
   [data] => [
           [0] => [
                   [id] => 1
                   [name] => Первый запрос
                   [sort] => 0
           ]
           [1] => [
                   [id] => 17
                   [name] => Звонок клиенту
                   [sort] => 1
           ]
           [2] => [
                   [id] => 18
                   [name] => Звонок клиенту
                   [sort] => 2
           ]
       ]
]

Запуск процесса

url: process/start/{id}
method: POST

Параметры: {data: [{entity_id:2, entity_type:1}, {entity_id:2, entity_type:1}]}

Описание параметров:

entity_type: тип сущности, для которой происходит запуск процесса. Всегда равен 1 (сделка).

entity_id: ИД экземпляра сущности. ИД сделки, для которой производится запуск процесса.

Пример запроса. Для теста запустите запрос в консоли браузера в amoCRM:

var sensei_api = function() {
        var baseUrl = 'https://api.sensei.plus/v1/';
        var self = this;
        this.send = function (url, method, data) {
            data = data || {};
            headers = {};
            headers.domain = AMOCRM.widgets.system.domain;
            headers.api_key = AMOCRM.widgets.system.amohash;
            headers.login = AMOCRM.widgets.system.amouser;
            var params = {
                url: baseUrl + url,
                data: data,
                method: method,
                dataType: 'json',
                headers: {
                    'X-Domain': headers.domain,
                    'X-Api-Key': headers.api_key,
                    'X-Login': headers.login,
                },
                success: function(data) {
                    console.log(data);                
            	}
	     };
            return new $.ajax(params);
        };
        this.startProcess = function (id, lead) {
            this.send('process/start/'+id, 'POST', {data: [{entity_id:lead, entity_type:1}]});
        };
};
api = new sensei_api;
api.startProcess(1, 1000); // 1 - ИД процесса, 1000 - ИД сделки

Пример ответа

[
   [status] => 200
   [message] => Process started
   [data] => null
]