BILLmanager API/Partner

Материал из ISPWiki

Перейти к: навигация, поиск
Условные обозначения
  • Image:B-std.png - доступно в BILLmanager Standard
  • Image:B-adv.png - доступно в BILLmanager Advanced
  • Image:B-corp.png - доступно в BILLmanager Corporate

Содержание

См. также


Партнер

Клиент

Пользователи

Image:b-std.png Image:b-adv.png Image:b-corp.png
Управление пользователями

Функция: user

Результат: список элементов

  • id - .
  • name - Имя пользователя.
  • realname - ФИО.
  • email - E-mail.
  • disabled - Доступ заблокирован.
  • superuser - Пользователь имеет права ко всем функциям.


Пользователь. Просмотр. Изменение

Функция: user.edit

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

  • Параметры:
    • elid - уникальный идентификатор (элемент "id" из функции "user")
  • Результат: список параметров

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):


Удалить пользователя

Функция: user.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "user".

Результат: успешное выполнение операции или сообщение об ошибке


Включить пользователя

Функция: user.enable

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "user".

Результат: успешное выполнение операции или сообщение об ошибке


Отключить пользователя

Функция: user.disable

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "user".

Результат: успешное выполнение операции или сообщение об ошибке


Контакты

Функция: user.contact

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "user").

Результат: список элементов

  • id - .
  • name - Контакт.
  • type - Тип.


Создание. Изменение. Редактирование контакта

Функция: user.contact.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент "id" из функции "user").
    • elid - уникальный идентификатор (элемент "id" из функции "user.contact")
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "id" из функции "user").
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "id" из функции "user").
    • elid - уникальный идентификатор (элемент "id" из функции "user.contact")
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type - Тип.
    При выбранном значении 1 разрешается использовать параметры: 'mobile' и запрещается использовать параметры: 'email','jabber'
При выбранном значении 2 разрешается использовать параметры: 'jabber' и запрещается использовать параметры: 'mobile','email'
  • email - E-mail.
  • mobile - Мобильный телефон.
  • jabber - Jabber.


'

Функция: user.contact.delete

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "user").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "user.contact".

Результат: успешное выполнение операции или сообщение об ошибке


Права доступа

Функция: user.access

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "user").

Результат: список элементов

  • ftitle - Наименование.
  • name - Функция.
  • active - Разрешено.
  • nochild - Не распространяется на уровни ниже.


Включить

Функция: user.access.enable

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "user").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user.access".

Результат: успешное выполнение операции или сообщение об ошибке


Отключить

Функция: user.access.disable

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "user").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user.access".

Результат: успешное выполнение операции или сообщение об ошибке


Установить везде фильтры по выбранному пользователю

Функция: user.setfilter


Товары/Услуги

Доменные имена

Image:b-std.png Image:b-adv.png Image:b-corp.png
Доменные имена

Функция: domain

Результат: список элементов

  • id - .
  • name - Имя.
  • expire - Дата окончания регистрации.
  • autoperiod - Автопродление.
  • domainstatus - Статус домена.
  • unverified - Не заверен.
  • processing - Документы отправлены.
  • verified - Заверен.
  • withdocs - Файлы прикреплены.


Изменить доменное имя. Просмотр. Изменение

Функция: domain.edit

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

  • Параметры:
    • elid - уникальный идентификатор (элемент "id" из функции "domain")
  • Результат: список параметров

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Доменное имя.
  • tld - Доменная зона.
  • idn - IDN.
  • autoperiod - Автопродление.
  • auth_code - Код подтверждения.
  • note - Заметки.
  • lowner - Владелец.
  • ladmin - Администратор.
  • ltech - Тех. поддержка.
  • lbill - Фин. администратор.
  • lnic - Анкета клиента.
  • ns0 - NS1.
  • ns1 - NS2.
  • ns2 - NS3.
  • ns3 - NS4.
  • dopns - Дополнительные NS. (Одно или несколько значений, разделенных пробелом)
  • changens - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • subjnic - Контракт.
  • pwd - Административный пароль.
  • tech_pwd - Технический пароль.


Удалить

Функция: domain.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "domain".

Результат: успешное выполнение операции или сообщение об ошибке


Центр поддержки

Категории

Image:b-std.png Image:b-adv.png Image:b-corp.png
Категории

Функция: supportcategories

Результат: список элементов

  • id - .
  • name - .
  • department - Отдел по умолчанию.
  • price - Цена.
  • project - .
  • enabled - Включено.


Создание. Изменение. Категория

Функция: supportcategories.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Название.
  • department - Отдел по умолчанию.
  • project - . Image:b-corp.png
  • pricelist - Категория запроса.
  • fullaccess - Полный доступ. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • notification - Новостная категория. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • estimate - Оценивать. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • alert - Предупреждение.


Удалить категорию

Функция: supportcategories.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "supportcategories".

Результат: успешное выполнение операции или сообщение об ошибке


Включить

Функция: supportcategories.enable

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "supportcategories".

Результат: успешное выполнение операции или сообщение об ошибке


Отключить

Функция: supportcategories.disable

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "supportcategories".

Результат: успешное выполнение операции или сообщение об ошибке


Разрешенные типы продуктов для категории

Функция: supportcategoriesaccess

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "supportcategories").

Результат: список элементов

  • name - Наименование типа продукта.
  • enabled - Включено.
  • pricelist - Категория доступна для отдельных тарифных планов.


Разрешить категорию для выбранных типов продуктов

Функция: supportcategoriesaccess.enable

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "supportcategories").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "supportcategoriesaccess".

Результат: успешное выполнение операции или сообщение об ошибке


Запретить категорию для выбранных типов продуктов

Функция: supportcategoriesaccess.disable

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "supportcategories").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "supportcategoriesaccess".

Результат: успешное выполнение операции или сообщение об ошибке


Разрешенные тарифные планы для категории

Функция: supportcategoriesaccess.pricelist

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "supportcategoriesaccess").

Результат: список элементов

  • name - Наименование тарифного плана.
  • enabled - Включено.


Разрешить категорию для выбранных тарифных планов

Функция: supportcategoriesaccess.pricelist.enable

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "supportcategoriesaccess").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "supportcategoriesaccess.pricelist".

Результат: успешное выполнение операции или сообщение об ошибке


Запретить категорию для выбранных тарифных планов

Функция: supportcategoriesaccess.pricelist.disable

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "supportcategoriesaccess").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "supportcategoriesaccess.pricelist".

Результат: успешное выполнение операции или сообщение об ошибке


Справочники

Домены верхнего уровня

Image:b-std.png Image:b-adv.png Image:b-corp.png
Домены верхнего уровня

Функция: tld

Результат: список элементов

  • id - .
  • name - Название.
  • registrar - Регистратор.


Создание. Изменение. Домен верхнего уровня

Функция: tld.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Название.
  • registrar - Регистратор.
  • minlenght - Минимальная длина.
  • isidn - IDN.
  • isoneyear - Регистрация не более года. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • notransfermoney - Трансфер без продления. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • isverified - Верификация документов. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • whoishost - Имя хоста whois.
  • wh_strnofound - Подстрока ответа whois.


Интеграция

Регистраторы

Image:b-std.png Image:b-adv.png Image:b-corp.png
Регистраторы

Функция: registrar

Результат: список элементов

  • id - .
  • registrar - Название.
  • balance - Баланс.


Создание. Изменение. Регистратор

Функция: registrar.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Название.
    При выбранном значении directi разрешается использовать параметры: 'chbalance','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','import'
При выбранном значении dnsbe разрешается использовать параметры: 'url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении manual разрешается использовать параметры: 'iswhois','reg_mail','mangrp' и запрещается использовать параметры: 'admgrp','chbalance','test','isbonus','remark','nichandle','url','usr','pwd','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении tucows разрешается использовать параметры: 'chbalance','url','usr','pwd','key','admgrp' и запрещается использовать параметры: 'mangrp','test','isbonus','remark','nichandle','reg_mail','lang','curr','tech_mail','host','parid','import'
При выбранном значении webnames разрешается использовать параметры: 'chbalance','reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','test','isbonus','remark','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении r01 разрешается использовать параметры: 'chbalance','isbonus','reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','test','remark','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении regru разрешается использовать параметры: 'reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении nic разрешается использовать параметры: 'chbalance','url','usr','pwd','lang','curr', 'tech_mail','admgrp' и запрещается использовать параметры: 'mangrp','test','isbonus','remark','nichandle', 'admgrp','key','host','parid','import','reg_mail'
При выбранном значении naunet разрешается использовать параметры: 'chbalance','reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','test','isbonus','remark','nichandle', 'admgrp','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении onic разрешается использовать параметры: 'url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении enom разрешается использовать параметры: 'url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении ukrnames разрешается использовать параметры: 'url','usr','pwd','nichandle','reg_mail','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении hostmaster разрешается использовать параметры: 'url','usr','pwd','remark','reg_mail','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении drs разрешается использовать параметры: 'url','usr','pwd','nichandle','reg_mail','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении regnames разрешается использовать параметры: 'reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении hosterkz разрешается использовать параметры: 'reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении mastername разрешается использовать параметры: 'reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении 101domain разрешается использовать параметры: 'reg_mail','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении net4all разрешается использовать параметры: 'test','url','usr','pwd','nichandle','reg_mail','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','isbonus','remark','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении rrpproxy разрешается использовать параметры: 'url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','parid','import'
При выбранном значении domenus разрешается использовать параметры: 'chbalance','url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','import'
При выбранном значении ascio разрешается использовать параметры: 'url','usr','pwd','admgrp' и запрещается использовать параметры: 'mangrp','chbalance','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','parid','import'
  • reg_mail - E-mail.
  • host - Хост.
  • url - URL-адрес.
  • username - Имя пользователя.
  • password - Пароль.
  • private_key - Секретный ключ.
  • currency - Валюта.
  • msg_lang - Язык сообщений.
  • nichandle - Ник-Хендл.
  • dop_remark - Дополнительная информация.
  • dop_isbonus - Бонусный счет. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • dop_test - Тестовый шлюз. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • admingroup - Ответственный отдел.
  • issenderror - Отправлять ошибки. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • isbalance - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
    Активный параметр разрешает следующие параметры: 'minbalance'
  • minbalance - Минимальный баланс.
  • manualgroup - Ответственный отдел.


Удалить

Функция: registrar.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "registrar".

Результат: успешное выполнение операции или сообщение об ошибке


Импортирование доменов

Функция: registrar.importdomain

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "registrar").

Результат: список элементов

  • name - Доменное имя.
  • account - Владелец.
  • expire - Дата окончания регистрации.
  • domainstatus - Статус домена.
  • yesdomain - Домен присутствует в системе.
  • nodomain - Домен отсутствует в системе.
  • notbigmatch - Серьезное несоответствие данных системы и регистратора.
  • notmidimatch - Незначительное несоответствие данных системы и регистратора.


Импортировать домены

Функция: registrar.importdomain.edit

  • domain - Доменные имена. (Одно или несколько значений, разделенных пробелом)


Синхронизировать данные доменов в системе с регистратором

Функция: importdomain.fixdomain

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "id" из функции "registrar").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "registrar.importdomain".

Результат: успешное выполнение операции или сообщение об ошибке


Свойства домена

Функция: registrar.domainprop

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "registrar.importdomain").

Результат: список элементов

  • prop - Свойство.
  • value - Значение у регистратора.
  • thisvalue - Текущее значение.


Тарифные планы для доменов

Функция: registrar.acc2domain.edit


Импорт хостинга

Функция: importhosting

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "registrar").

Результат: список элементов

  • id - Уникальный идентификатор элемента списка.
  • domainname - Доменное имя.
  • contract - Владелец.
  • domain - Идентификатор.
  • type - Тарифный план.
  • enddate - Действует до.
  • exist - Присутствует в BILLmanager - .
  • active - Активен.


Загрузка списка услуг

Функция: importhosting.edit

  • domains - Идентификаторы. (Одно или несколько значений, разделенных пробелом)


Привязка услуги. Просмотр. Изменение

Функция: importhosting.assign

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент "id" из функции "registrar").
    • elid - уникальный идентификатор (элемент "id" из функции "importhosting")
  • Результат: список параметров

Изменение объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "id" из функции "registrar").
    • elid - уникальный идентификатор (элемент "id" из функции "importhosting")
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • client - Клиент.


  • Список активных возможностей можно получить через API-функцию "featurelist"
Источник — «http://ru.ispdoc.com/index.php/BILLmanager_API/Partner»
Была ли эта информация полезной? Да | Нет
Личные инструменты