(044) 538-1588
всі способи зв'язку
та вирішення проблем
сайт на украинскомUA сайт на русскомRU
 
 
  1gb - .net, ASP, Windows, Apache, PHP хостинг

API для роботи з хостингом        beta

APIAPI для роботи з хостингом дозволяє автоматизувати управління ресурсами і аналіз даних.

Приклади використання API хостингу:

  • Відстеження стану аккаунта і своєчасний аналіз повідомлень
  • Автоматичне створення, видалення, конфігурація ресурсів
  • Доступ до даних внутрішнього моніторингу 1Gb.ua, аналіз якості роботи VDS
  • Автоматизація типових реакцій на проблеми ресурсів і хостингу

Доступ до API хостингу активний в будь-якому сплаченому тарифному плані. Для тестових або безкоштовних акаунтів API не працює.

Принципи роботи і приклади

Доступ відбувається по протоколу HTTPS за базовою адресою https://www.1gb.ua/api/. Параметри більшості запитів можна передавати за допомогою GET або POST параметрів. Відповідь містить об'єкт або масив об'єктів за стандартом JSON.

Перед початком роботи з API потрібно отримати token для подальшої авторизації. Це робиться в такий спосіб (наведені приклади використання GET параметрів):

  • https://www.1gb.ua/api/auth/start?login=[логин_кабинета] - повертає у відповідь string, що містить сіль
  • https://www.1gb.ua/api/auth/login?login=[логин_кабинета]&salt=[сіль]&response=[md5(пароль+сіль+символ-переводу-рядка)] - повертає у відповідь string, що містить token;
    псевдокод для вичислення response на PHP: md5($password.$salt."\n")

Останній запит повертає string, в ньому token, його потрібно запам'ятати і використовувати для подальшої авторизації. Token втрачає силу при зміні головного пароля аккаунта, існує також можливість деактивувати окремі token-и зі сторінки кабінету "зміна головного пароля аккаунта".

Приклади подальших запитів:

  • https://www.1gb.ua/api/billing/info?_token_=[ваш token] - отримання загальних даних аккаунта

Відповіді API з HTTP кодом 200 позначають успішне виконання операції. У відповідному JSON може міститися два різних типи:

  • [ "string" ]: або просто "OK", або "[число]" (необхідно привести до int), якщо повертається ID створеного об'єкта
  • [ { ... } , { ... } ] (масив об'єктів): якщо запит повертає список з 0 або більше структур (хеш "поле": "значення").
Інші коди (більше 200) позначають помилку, при цьому тіло відповіді містить string з поясненням, приклад: "ERROR: vds.missing".

Команди API і загальні умови

Більшість команд API, таких як /list, повертають внутрішні структури з бази даних хостингу, які містять сотні полів. Документувати їх занадто багато роботи, тому рекомендуємо просто дивитися на вивід відповідних команд і аналізувати структури даних з очевидних назв полів.

У тому випадку, якщо трактування полів викликає труднощі, пишіть на support@1gb.ua, допоможемо розібратися.

В даний час йде процес наповнення/створення повної документації до API на основі http://swagger.io/, де буде систематизована вся доступна інформація.

Загальнодоступні на даний момент команди

https://www.1gb.ua/api + адреса зі списку нижче. Обов'язковий параметр кожної команди - _token_. Інші параметри наведені після команди. У квадратних дужках - необов'язкові. В круглих - приклади або замовчування.


/auth/start
	login

/auth/login
	login
	salt
	response

/c2dmkey/set
	_key_
	Internal usage, do not call.

/gcmkey/set
	_key_
	Internal usage, do not call.

/iospushkey/set
	_key_
	Internal usage, do not call.

/billing/info

/billing/limits

/billing/balance

/billing/balance.lic

/billing/debt

/updates/list
	_key_ - first ID or 0 to show all

/updates/last

/vds/list
	[_key_] - /vds/list|id

/vds/ip/list
	[_key_] - /vds/list|id

/vds/templates-list

/vds/create
	[type] (vds.dynamic) vz1|vz2|vz3|vz4|vz5|vds.dynamic
	[cr_hvmem] (2048)
	[cr_hvdsk] (30)
	[cr_hvcpu] (2)
	[template] (win2012R2x64)
	[force_memo]
	[hv_1gb_panel_version]
	[panel_install] - 1|0
	[cr_ssd1] - 1|0
	[cr_hv_all_system] - 1|0
	
/vds/update
	_key_ - /vds/list|id
	[cr_hvmem] (2048)
	[cr_hvdsk] (30)
	[cr_hvcpu] (2)	
	
/vds/ip/add
	_key_ - /vds/list|id
	
/vds/ip/delete
	_key_ - /vds/list|id
	del_ip
	
/vds/reboot
	_key_ - /vds/list|id
	
/vds/delete
	_key_ - /vds/list|id
	[force_critical] - 1|0
	
/vds/online
	_key_ - /vds/list|id
	online - 1|0

/email/list

/email/alias/list

/email/add
	add_email

/email/delete
	_key_ - email address (string)

/email/alias/delete
	_key_ - email address (string)

/website/add
	name - website name (temp subdomain), keep simple, unique and short
	srv_type -
		99901	Best for PHP
		99902	Best for ASP, ASP.NET
		99903	Best for Static Content
		8	.NET 2 - 3.5
		99904	.NET 4+, .Core
		1	Legacy ASP + .NET 2 - 3.5
		4	mod_php 5.2
		9	mod_php 5.3
		10	mod_php 5.4
		11	mod_php 5.5
		12	mod_php 5.6
		13	mod_php 7
		15	mod_php 7.1
		16	mod_php 7.2
		17	mod_php 7.3
		18	mod_php 7.4
		19	mod_php 8.0
		5	PHP - FastCGI
		6	PHP - CGI (not recommended)
		20008	Frankfurt - .NET 2 - 3.5
		29994	Frankfurt - .NET 4+
		2004	Frankfurt - mod_php 5.2
		2009	Frankfurt - mod_php 5.3
		2010	Frankfurt - mod_php 5.4
		2011	Frankfurt - mod_php 5.5
		2005	Frankfurt - PHP - FastCGI
	
/website/list

/website/delete
	_key_ - /website/list|id

/ftp/list
	(not recommented - use /website/ API)

/ftp/delete
	_key_ - /ftp/list|id
	(not recommented - use /website/ API)

/dns/list

/dns/add
	add_dns_zone
	[add_dns_record]
	[iis_site_for_dns] - /website/list|id OR "ip_a.b.c.d" string to bind to VDS
	[bind_only] - 1|0

/dns/bind
	_key_ - /dns/list|id
	[dns_to] - /website/list|id OR "ip_a.b.c.d" string to bind to VDS

/dns/delete
	_key_ - /dns/list|id

/dns/raw/managedmx
	_key_ - /dns/list|id
	upd_managed_mx - 1
	managed_mx - 1|0 - add/keep/update (1) or delete (0) hosting-managed root MX record

/dns/raw
	_key_ - /dns/list|id
	s_del = 1 to delete record, DO NOT specify ANY s_del to create record
	s_add = 1 to create record, DO NOT specify ANY s_add to delete record
	dns_type = A,MX,CNAME,AAAA,NS,TXT,SRV
	dns_name = record name or @ for root
	dns_value = record content, dnscmd.exe format (A: [ip], CNAME: [name], MX: [priority] [target])

/database/list

/mssql/list

/dns/prolong/list

/chat/key

 

Корисна порада
      

API хостингу функціонує вже багато років для підтримки різних сценаріїв, таких як масові послуги для VDS клієнтів. Тепер ми вирішили надати до цих API публічний доступ.

Поточний функціонал API не покриває 100% можливостей хостингу, але ми готові швидко розширити його для потрібного функціоналу буквально в лічені дні. Якщо у вас є реальна необхідність в автоматизації якихось конкретних операцій, відсутніх в поточних функціях або поки не опублікованих тут, сміливо пишіть на support@1gb.ua.

Бажаєте стати клієнтом нашого хостингу? Спробуйте наші послуги та сервіс.
Тестовий період до 10 днів, OK реєстрація займає всього одну хвилину.
Будемо раді бачити вас нашим клієнтом!

Зміст технічної документації

 

Ми завжди готові відповісти на Ваші запитання!
 
Будь-які питання та підтримка - support@1gb.ua
інші способи зв'язку

 

vip hosting
Як уберегти ваш сервер від непередбачених ситуацій?
Резервне копіювання VDS

 

 

   
 
Вгору     
Підтримка: support@1gb.ua
інші способи зв'язку
© 2005-2021 ТОВ 1ГБ