Uživatelské nástroje

Nástroje pro tento web


navody:vps:api

Rozdíly

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

Odkaz na výstup diff

Obě strany předchozí revizePředchozí verze
Následující verze
Předchozí verze
navody:vps:api [2024/01/02 18:37] – Scopes aithernavody:vps:api [2026/05/28 12:15] (aktuální) domogled
Řádek 8: Řádek 8:
 ===== Dokumentace API ===== ===== Dokumentace API =====
 Dokumentace API, tzn. seznam zdrojů, 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/v6.0/.+parametrů je k vidění na https://api.vpsfree.cz/.
  
 Bez přihlášení se zobrazuje seznam všech zdrojů, 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
Řádek 36: Řádek 36:
 dat, který HaveAPI klienti abstrahují, je k nahlédnutí v dat, který HaveAPI klienti abstrahují, je k nahlédnutí v
 [[https://api.vpsfree.cz/doc/protocol.md|dokumentaci]]. [[https://api.vpsfree.cz/doc/protocol.md|dokumentaci]].
 +
 +**poznámka** Pokud API vpsfree vrací http kód 500, ujistěte se, že váš REST klient posílá http hlavičku `User-Agent: x"`, která nesmí být prázdným řetězcem. Nejspíš jsou povinné i hlavičky `Accept: application/json` a `"Content-Type: application/json`. Většina http rest knihoven hlavičku `User-Agent` přidá automaticky, ale některé to nedělají.
 +
 +
  
 ===== Autentizace ===== ===== Autentizace =====
Řádek 62: Řádek 66:
   * //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+  * //permanent// - token je platný napořád, resp. dokud není smazán
  
 Typ tokenu a časový interval, o který se prodlužuje, si volí klient. Typ tokenu a časový interval, o který se prodlužuje, si volí klient.
Řádek 75: Řádek 79:
  
   * ''all'' povolí přístup ke všem akcím, toto je výchozí hodnota   * ''all'' povolí přístup ke všem akcím, toto je výchozí hodnota
-  * prázdný scope, přístup je povolen jen k akci `user#current`, což zobrazí info o aktuálním uživateli; toto se využívá pro přihlášení do Discourse a KB+  * prázdný scope, přístup je povolen jen k akci ''user#current'', což zobrazí info o aktuálním uživateli; toto se využívá pro přihlášení do Discourse a KB
   * ''vps#show'' povolí zobrazení info o jakékoli VPS   * ''vps#show'' povolí zobrazení info o jakékoli VPS
   * ''vps#show:vps_id=123'' info o VPS s ID 123   * ''vps#show:vps_id=123'' info o VPS s ID 123
Řádek 87: Řádek 91:
 [[https://github.com/vpsfreecz/vpsfree-client|Klient pro Ruby]] obsahuje CLI [[https://github.com/vpsfreecz/vpsfree-client|Klient pro Ruby]] obsahuje CLI
 (rozhraní pro příkazovou řádku) a knihovnu pro použití v Ruby skriptech. (rozhraní pro příkazovou řádku) a knihovnu pro použití v Ruby skriptech.
-Pro správnou funkci vyžaduje Ruby >= 2.7 nainstalované hlavičkové soubory +Pro správnou funkci vyžaduje Ruby >= 2.7nainstalované hlavičkové soubory 
-Ruby, OpenSSL a ncurses (většinou balíčky s příponou ''-dev'' či ''-devel'').+Ruby a ncurses (většinou balíčky s příponou ''-dev'' či ''-devel'').
 Poté klienta nainstalujeme pomocí Ruby gems: Poté klienta nainstalujeme pomocí Ruby gems:
  
Řádek 321: Řádek 325:
 Při vytváření tokenu můžeme specifikovat scope: Při vytváření tokenu můžeme specifikovat scope:
 <code bash> <code bash>
-vpsfreectl --auth token --scope 'vps#*:vps_id=123' --save vps show 123+vpsfreectl --auth token --scope 'vps#*:vps_id=123' --save vps show 123
 </code> </code>
  
navody/vps/api.1704220640.txt.gz · Poslední úprava: autor: aither