Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

--- navody:vps:api [2018/11/28 19:48] – [Práce s API] fix haveapi js lib url uxes
+++ navody:vps:api [2024/01/02 18:20] – Aktualizace autentizace aither
@@ Řádek 2: / Řádek 2: @@
 ====== API ======
-Naše API běží na adrese https://api.vpsfree.cz. Pomocí API lze vykonat většinu
+Naše API běží na adrese https://api.vpsfree.cz. Pomocí API lze vykonat vše
-akcí, stejně jako z webového rozhraní. V API aktuálně není zahrnuta pouze
+co jde naklikat ve webovém rozhraní, a více. Ve skutečnosti webové rozhraní
-správa uživatelských profilů (adresa, e-mail, apod.).
+běžící na https://vpsadmin.vpsfree.cz pro každý úkon volá API.
-Ve skutečnosti webové rozhraní běžící na https://vpsadmin.vpsfree.cz API
-využívá a pro každý úkon jej volá.
 ===== Dokumentace API =====
-Dokumentace API, tzn. seznam objektů, možných akcí, vstupních a výstupních
+Dokumentace API, tzn. seznam zdrojů, možných akcí, vstupních a výstupních
-parametrů je k vidění na https://api.vpsfree.cz/v5.0/.
+parametrů je k vidění na https://api.vpsfree.cz/v6.0/.
-Bez přihlášení se zobrazuje seznam všech objektů, tj. i těch, se kterými můžou
+Bez přihlášení se zobrazuje seznam všech zdrojů, tj. i těch, se kterými můžou
 pracovat pouze administrátoři. Vpravo nahoře se lze přihlásit stejnými údaji
 jako do vpsAdminu a poté se zobrazí pouze objekty, akce a parametry, se
@@ Řádek 26: / Řádek 23: @@
   * Ruby - https://github.com/vpsfreecz/vpsfree-client
-  * PHP - https://github.com/vpsfreecz/haveapi-client-php
+  * PHP - https://github.com/vpsfreecz/haveapi/tree/master/clients/php
   * JavaScript - https://github.com/vpsfreecz/haveapi/tree/master/clients/js
-  * Webové rozhraní z HaveAPI - https://github.com/vpsfreecz/haveapi-webui
+  * Go - https://github.com/vpsfreecz/haveapi/tree/master/clients/go
-  * Souborový systém založený na FUSE - https://github.com/vpsfreecz/haveapi-fs
+  * Webové rozhraní z HaveAPI - https://github.com/vpsfreecz/haveapi-webui (zastaralé)
+  * Souborový systém založený na FUSE - https://github.com/vpsfreecz/haveapi-fs (zastaralé)
 Ukázka použití je vždy v ''README.md'' každého klienta. Obecně se klientovi
@@ Řádek 40: / Řádek 38: @@
 ===== Autentizace =====
-Lze využívat dvě autentizační metody. Tou první a jednodušší z nich je HTTP
+API podporuje dva způsoby autentizace:
-basic. S každým požadavkem na API se musí zaslat jméno a heslo. Je to dobrá
-volba pro jednorázové akce, pokud je ale potřeba API volat vícekrát nebo
-automatizovaně, ukládání hesla na disk či neustálé opisování není dobrý nápad.
-Druhou metodou je autentizace přes tokeny. Funguje to tak, že klient nejprve
+  * [[#http_basic|HTTP Basic]]
-požádá o vytvoření tokenu, k tomu potřebuje jméno a heslo. Jakmile dostane
+  * [[#tokeny|Pomocí tokenů]]
-token, může jméno a heslo zapomenout a dále se autentizuje získaným tokenem.
+Konkrétní ukázky autentizace pro podporované programovací jazyky a CLI najdete
+v [[https://api.vpsfree.cz/v6.0/#auth|dokumentaci API]].
+==== HTTP Basic ====
+S každým požadavkem na API se musí zaslat jméno a heslo v HTTP hlavičče "Authorization".
+Je to dobrá volba pro jednorázové akce, pokud je ale potřeba API volat vícekrát nebo
+automatizovaně, ukládání hesla na disk či neustálé opisování není dobrý nápad. HTTP basic
+nelze použít, pokud máte aktivované dvoufaktorové ověřování.
+==== Tokeny ====
+Klient nejprve požádá o vytvoření tokenu, k tomu potřebuje jméno, heslo a připadně i TOTP.
+Jakmile klient dostane token, může jméno a heslo zapomenout a dále se autentizuje
+získaným tokenem.
 Tokeny mohou být několika typů s různě dlouhou životností:
-  * fixed - platnost tokenu je pevně dána
+  * //fixed// - platnost tokenu je pevně dána
-  * renewable_manual - platnost tokenu lze manuálně prodloužit
+  * //renewable_manual// - platnost tokenu lze manuálně prodloužit
-  * renewable_auto - platnost tokenu je prodloužena při každém požadavku
+  * //renewable_auto// - platnost tokenu je prodloužena při každém požadavku
-  * permament - token je platný napořád, resp. dokud není smazán
+  * //permament// - token je platný napořád, resp. dokud není smazán
 Typ tokenu a časový interval, o který se prodlužuje, si volí klient.
-===== CLI =====
+===== Instalace klienta =====
-[[https://github.com/vpsfreecz/vpsfree-client|Klient pro Ruby]] obsahuje i CLI.
+[[https://github.com/vpsfreecz/vpsfree-client|Klient pro Ruby]] obsahuje CLI
-Pro správnou funkci vyžaduje Ruby >= 2.0 a nainstalované hlavičkové soubory
+(rozhraní pro příkazovou řádku) a knihovnu pro použití v Ruby skriptech.
+Pro správnou funkci vyžaduje Ruby >= 2.7 a nainstalované hlavičkové soubory
 Ruby, OpenSSL a ncurses (většinou balíčky s příponou ''-dev'' či ''-devel'').
+Poté klienta nainstalujeme pomocí Ruby gems:
-<note>
-Na OS X je nutné nainstalovat OpenSSL přes [[http://brew.sh/|Homebrew]] a až
-poté se dá nainstalovat EventMachine (gem, jenž klient vyžaduje).
 <code bash>
-$ brew install openssl
+gem install vpsfree-client
-$ sudo gem install eventmachine -- --with-opt-include="/usr/local/opt/openssl/"
 </code>
-</note>
-Nainstalovat jej lze pomocí ruby gems:
+Konkrétní postupy instalace podle platformy:
-<code bash>
-$ sudo gem install vpsfree-client
-</code>
-<note>
-gem vypíše PATH pod kterým lze najít nainstalovaný balíček
-<code bash>
-WARNING:  You don\'t have /home/user/.gem/ruby/2.5.0/bin in your PATH,
-	  gem executables will not run.
-</code>
-</note>
-==== Instalace ve Windows 10 využitím Ubuntu Linux subsystem ====
-=== Instalace Ubuntu (Linux subsystemu Windows 10) ===
-  - ve Windows 10 povolit developer mode, nechat nainstalovat
-  - přes Programy a funkce otevřít přidání součástí Windows, úplně dole zvolit Linux subsystem, nechat nainstalovat a restartovat počítač
-  - po restartu jako admin spustit v nabídce Start bash
-  - vytvořit Unix username a heslo
-  - stisknout y a nechat nainstalovat základ Ubuntu
-=== Instalace závislostí ===
-<code bash>
-sudo apt-get install ruby2.1 ruby2.1-dev libssl-dev make g++
-</code>
-=== Quick & Dirty fix pro nastavení ruby2.1 jako výchozího namísto 1.9 ===
-<code bash>
-sudo rm /usr/bin/ruby /usr/bin/gem /usr/bin/irb /usr/bin/rdoc /usr/bin/erb
-sudo ln -s /usr/bin/ruby2.1 /usr/bin/ruby
-sudo ln -s /usr/bin/gem2.1 /usr/bin/gem
-sudo ln -s /usr/bin/irb2.1 /usr/bin/irb
-sudo ln -s /usr/bin/rdoc2.1 /usr/bin/rdoc
-sudo ln -s /usr/bin/erb2.1 /usr/bin/erb
-sudo gem update --system
-sudo gem pristine --all
-</code>
-Zdroj: http://blog.costan.us/2014/04/restoring-ruby-20-on-ubuntu-1404.html
-=== Instalace vpsfree-client ===
-<code bash>
-sudo gem install vpsfree-client
-</code>
-----
+  * Linux
+    * [[navody:vps:api:arch|Arch Linux]]
+    * [[navody:vps:api:centos|CentOS]]
+    * [[navody:vps:api:ubuntu|Ubuntu 20.04]]
+  * [[navody:vps:api:macos|macOS]]
+  * [[navody:vps:api:windows|Windows]]
 Po instalaci by v ''$PATH'' měl být k dispozici ''vpsfreectl''. Pokud tomu tak
@@ Řádek 140: / Řádek 97: @@
 <code bash>
-$ PATH="$PATH:/home/user/.gem/ruby/2.0.0/bin"
+$ PATH="$PATH:/home/user/.gem/ruby/2.7.0/bin"
 </code>
-==== Použití ====
+===== Použití CLI =====
 <code>
@@ Řádek 187: / Řádek 144: @@
 Available resources:
-auth_token
 cluster
 cluster_resource
+cluster_resource_package
+cluster_resource_package.item
 dataset
 dataset.snapshot
@@ Řádek 199: / Řádek 157: @@
 environment.config_chain
 environment.dataset_plan
+host_ip_address
 integrity_check
 integrity_fact
 integrity_object
 ip_address
-ip_range
 ip_traffic
 ip_traffic_monitor
@@ Řádek 216: / Řádek 174: @@
 migration_plan.vps_migration
 network
+network_interface
 node
 node.status
@@ Řádek 221: / Řádek 180: @@
 os_template
 pool
+session_token
 snapshot_download
+system_config
 transaction
 transaction_chain
@@ Řádek 228: / Řádek 189: @@
 user.cluster_resource
 user.public_key
+user.mail_role_recipient
+user.mail_template_recipient
 user.state_log
+user_cluster_resource_package
+user_cluster_resource_package.item
+user_namespace
+user_namespace_map
+user_namespace_map.entry
 user_session
 vps
@@ Řádek 234: / Řádek 202: @@
 vps.config
 vps.feature
-vps.ip_address
 vps.mount
 vps.outage_window
@@ Řádek 240: / Řádek 207: @@
 vps.status
 vps_config
+monitored_event
+monitored_event.log
+outage
+outage.entity
+outage.handler
+outage_update
+user_outage
+vps_outage
+vps_outage_mount
+help_box
+news_log
+incoming_payment
+payment_stats
+user_account
+user_payment
+user_request
+user_request.registration
+user_request.change
 action_state
 </code>
@@ Řádek 268: / Řádek 253: @@
     -a, --auth METHOD                Authentication method
     -s, --save                       Save credentials to config file for later
-        --username USER              User name
+        --user USER                  User name
         --password PASSWORD          Password
         --token TOKEN                Token
@@ Řádek 686: / Řádek 671: @@
 aither
 </maintainers>

Znalostní báze

Uživatelské nástroje

Nástroje pro tento web

Rozdíly

Nástroje pro stránku