Passwork Legacy API

7min
API предоставляет доступ к основным возможностям Passwork и позволяет интегрировать Passwork в свою инфраструктуру или разработать собственный клиент.
General
Данные отправляются используя HTTP POST запросы
API End Point — https:///api3/
Данные возвращаются в формате JSON
Рекомендуется использовать защищенное SSL соединение
Ответ сервера
Shell
{
    'response' : { ... },
    'errorCode' : '...',
    'errorMessage' : '...'
}
{
    'response' : { ... },
    'errorCode' : '...',
    'errorMessage' : '...'
}
﻿
В случае ошибки response — false..
Создание сессии
/api3/openSession
Возвращает код сессии, который надо передавать в каждом запросе. Сессия автоматически истекает каждые несколько минут.
POST parameters:
email — емейл пользователя
password — пароль
Ответ сервера:
Success
Shell
{
    'code' : '...', // session code
    'hash' : '...'  // sha256 (or md5 for old versions) hash of a master password
}
{
    'code' : '...', // session code
    'hash' : '...'  // sha256 (or md5 for old versions) hash of a master password
}
﻿
Поле сode потребуется указывать в каждом последующем запросе к API. Поле hash требуется для того, чтобы клиент смог определить корректность мастер-пароля.
Ошибки:
response = false
Возвращается в случае неверного логина или пароля.
errorCode = ban
В случае бана, если бы совершено несколько неудачных попыток авторизации.
Загрузить сейфы и папки
/api3/getGroups
Получает структуру сейфов и папок.
POST Parameters:
session — код сессии
Ответ сервера:
Shell
{
   "response":[
      {
         "groupId":"5d52d812b05d4b49ea05faf2",
         "name":"Vault 1",
         "passwordCrypted":"....",
         "access":"admin",
         "categories":[

         ],
         "scope":"user",
         "id":"5d52d812b05d4b49ea05faf2"
      },
      {
         "groupId":"5d41b39fb05d4b07214bcff2",
         "name":"Vault 2",
         "passwordCrypted":"....",
         "access":"admin",
         "categories":[
            {
               "groupId":"5d41b39fb05d4b07214bcff2",
               "name":"Folder",
               "ancestors":[

               ],
               "id":"5d53ffabb05d4b5fce177903",
               "level":0,
               "hasChild":true,
               "categories":[
                  {
                     "groupId":"5d41b39fb05d4b07214bcff2",
                     "name":"Subfolder",
                     "parentId":"5d53ffabb05d4b5fce177903",
                     "ancestors":[
                        "5d53ffabb05d4b5fce177903"
                     ],
                     "id":"5d53ffbbb05d4b5fc5676c15",
                     "level":1,
                     "hasChild":false,
                     "categories":[

                     ]
                  }
               ]
            }
         ],
         "scope":"domain",
         "visible":true,
         "domainMaster":"....",
         "id":"5d41b39fb05d4b07214bcff2"
      },
      {
         "groupId":"5d4d6a0fb05d4b66146f5262",
         "name":"Private Vault",
         "passwordCrypted":"....",
         "access":"admin",
         "categories":[

         ],
         "scope":"domain",
         "visible":true,
         "domainMaster":"....",
         "id":"5d4d6a0fb05d4b66146f5262"
      }
   ]
}
{
   "response":[
      {
         "groupId":"5d52d812b05d4b49ea05faf2",
         "name":"Vault 1",
         "passwordCrypted":"....",
         "access":"admin",
         "categories":[

         ],
         "scope":"user",
         "id":"5d52d812b05d4b49ea05faf2"
      },
      {
         "groupId":"5d41b39fb05d4b07214bcff2",
         "name":"Vault 2",
         "passwordCrypted":"....",
         "access":"admin",
         "categories":[
            {
               "groupId":"5d41b39fb05d4b07214bcff2",
               "name":"Folder",
               "ancestors":[

               ],
               "id":"5d53ffabb05d4b5fce177903",
               "level":0,
               "hasChild":true,
               "categories":[
                  {
                     "groupId":"5d41b39fb05d4b07214bcff2",
                     "name":"Subfolder",
                     "parentId":"5d53ffabb05d4b5fce177903",
                     "ancestors":[
                        "5d53ffabb05d4b5fce177903"
                     ],
                     "id":"5d53ffbbb05d4b5fc5676c15",
                     "level":1,
                     "hasChild":false,
                     "categories":[

                     ]
                  }
               ]
            }
         ],
         "scope":"domain",
         "visible":true,
         "domainMaster":"....",
         "id":"5d41b39fb05d4b07214bcff2"
      },
      {
         "groupId":"5d4d6a0fb05d4b66146f5262",
         "name":"Private Vault",
         "passwordCrypted":"....",
         "access":"admin",
         "categories":[

         ],
         "scope":"domain",
         "visible":true,
         "domainMaster":"....",
         "id":"5d4d6a0fb05d4b66146f5262"
      }
   ]
}
﻿
Ошибки:
Shell
{
    'response' : false,
    'errorCode' : 'expired',
    'errorMessage' : 'Session expired'
}
{
    'response' : false,
    'errorCode' : 'expired',
    'errorMessage' : 'Session expired'
}
﻿
Сессия истекла. Требуется открытие новой сессии через метод openSession.
Загрузка паролей
/api3/getPasswords
Получает список паролей из папки или сейфа.
POST parameters::
session — код сессии
groupdId — ID сейфа
categoryId — ID папки
Shell
{ 
   "response":[ 
      { 
         "name":"Password name",
         "login":"Login",
         "cryptedPassword":"...",
         "url":"",
         "groupId":"5d41b39fb05d4b07214bcff2",
         "attachments":[ ],
         "id":"5d41b3a7b05d4b079112c2b2",
         "tags":[ ]
      }
   ]
}
{ 
   "response":[ 
      { 
         "name":"Password name",
         "login":"Login",
         "cryptedPassword":"...",
         "url":"",
         "groupId":"5d41b39fb05d4b07214bcff2",
         "attachments":[ ],
         "id":"5d41b3a7b05d4b079112c2b2",
         "tags":[ ]
      }
   ]
}
﻿
Как расшифровать пароли
JavaScript-style pseudo-code.
Shell
var decode = function(data, pwd) {
/*
	Проверяем вклюено ли шифрование на клиенте.
	Шифрование на клиенте всегда включено для облачной версии.
  Шифрование на клиенте по умолчанию выключено в коробочной версии.

  creds.crypto — мастер-пароль пользователя.
*/
        if(creds.encryption)
        {
            pwd = pwd ? pwd : creds.crypto;
						return CryptoJS.AES.decrypt(base32.decode(data), pwd).
							toString(CryptoJS.enc.Utf8);
        }

/*
Если клиентское шифрование отключено, то используется Base64 кодировка.
*/        
		    return base64decode(data);
}

/*
data — password object loaded from the API
group — vault object loaded from the API
*/
var parsePassword = function(data, group) {

        var groupPassword = false;
/*
group.scope === 'user' — Частный сейф
group.scope === 'domain' — Сейф организации

Сейфы огранизации доступны только в коробочной версии.
*/
        if(group.scope === 'user'){
            groupPassword = decode(group.passwordCrypted);
        }else{
            var domainPassword = decode(group.domainMaster);
            groupPassword = decode(group.passwordCrypted, domainPassword);
        }

/*
Inject methods to decrypt the password.
*/
        data.getPassword = function() {
            return decode(this.cryptedPassword, groupPassword);
        }

        data.getCustom = function() {
            if (!data.custom)
                return [];

            return this.custom.map(function(el) {
                return {
                    'name': decode(el.name, groupPassword),
                    'value': decode(el.value, groupPassword)
                };
            });
        }
		
		return data;
}
var decode = function(data, pwd) {
/*
	Проверяем вклюено ли шифрование на клиенте.
	Шифрование на клиенте всегда включено для облачной версии.
  Шифрование на клиенте по умолчанию выключено в коробочной версии.

  creds.crypto — мастер-пароль пользователя.
*/
        if(creds.encryption)
        {
            pwd = pwd ? pwd : creds.crypto;
						return CryptoJS.AES.decrypt(base32.decode(data), pwd).
							toString(CryptoJS.enc.Utf8);
        }

/*
Если клиентское шифрование отключено, то используется Base64 кодировка.
*/        
		    return base64decode(data);
}

/*
data — password object loaded from the API
group — vault object loaded from the API
*/
var parsePassword = function(data, group) {

        var groupPassword = false;
/*
group.scope === 'user' — Частный сейф
group.scope === 'domain' — Сейф организации

Сейфы огранизации доступны только в коробочной версии.
*/
        if(group.scope === 'user'){
            groupPassword = decode(group.passwordCrypted);
        }else{
            var domainPassword = decode(group.domainMaster);
            groupPassword = decode(group.passwordCrypted, domainPassword);
        }

/*
Inject methods to decrypt the password.
*/
        data.getPassword = function() {
            return decode(this.cryptedPassword, groupPassword);
        }

        data.getCustom = function() {
            if (!data.custom)
                return [];

            return this.custom.map(function(el) {
                return {
                    'name': decode(el.name, groupPassword),
                    'value': decode(el.value, groupPassword)
                };
            });
        }
		
		return data;
}
﻿
Ограничения API
API работает в режиме чтения. Изменения и добавление данные через API невозможно.
Обновлено 22 Nov 2023
Помогла ли вам эта страница?
CentOS 7
Docker
Docs powered by Archbee
СОДЕРЖАНИЕ
Создание сессии
/api3/openSession
Загрузить сейфы и папки
Загрузка паролей
Как расшифровать пароли
Ограничения API