Описание

Модифицированная версия planfix-api. Добавлены недостающие методы и обработка ошибок.

Инициализация

constplanfix=require('planfix-client');constclient=planfix({account: 'your_account_name',privateKey: 'your_private_key',apiKey: 'your_api_key',url: 'your_planfix_url',//optionaltoken: 'your_planfix_auth_token'//optional});

Авторизация по логину/паролю

Перед тем как вызывать любыем методы, необходимо произвести авторизацию, после чего клиент будем прикреплять id сессии к каждому запросу автоматически

client.auth.login({login: 'John',password: 'Galt'});

Авторизация по токену

Если в параметры инициализации был передан токен, метод auth.login вызывать не нужно.

Доступные методы

Имена методов и их параметры совпадают с оригинальной документацией, только вместо xml используется json (автоматически кновертируется в xml)

Пример использования

// Авторизация по логину и паролюclient.auth.login({login: 'John',password: 'Galt'}).then(()=>client.user.getList({pageCurrent: 1,pageSize: 100})).then(res=>console.log(res.users.user))// Авторизация по токенуclient.user.getList({pageCurrent: 1,pageSize: 100}).then(res=>console.log(res.users.user))

Обработка ошибок

В случае возникновения ошибки в catch блок будет возвращен Error c ее описанием. Коды ошибок с описанием тут

type PlanfixError = {
statusCode: string // 400
code: string // 1001 message: string // planfix message
description: string // Неверный логин или пароль
}