Vai al contenuto principale
POST
/
instances
Crea un'istanza captive portal
curl --request POST \
  --url https://api.altostrat.io/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "WiFi Ospiti Ufficio Principale",
  "strategy": "oauth2",
  "session_ttl": 43200,
  "auth_integration_id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f"
}'
{
  "id": "9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "auth_integration_id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
  "strategy": "oauth2",
  "name": "WiFi Ospiti Ufficio Principale",
  "session_ttl": 43200,
  "auth_window_ttl": 300,
  "theme": {
    "logo": "https://api.altostrat.io/captive/assets/.../logo_abc123.png?signature=...",
    "icon": "https://api.altostrat.io/captive/assets/.../icon_def456.png?signature=...",
    "accent_text": "#FFFFFF",
    "accent_color": "#0396d5",
    "text_color": "#4f4f4f",
    "secondary_text_color": "#8f8f8f",
    "background_color": "#f9f9f9",
    "border_color": "#e0e0e0",
    "box_color": "#ffffff"
  },
  "terms_text": "Connettendoti, accetti i nostri termini di servizio...",
  "sites": [
    {
      "id": "a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
      "subnets": [
        "192.168.88.0/24"
      ]
    }
  ],
  "created_at": "2025-10-29T12:00:00Z",
  "preview_url": "https://captive.altostr.at/preauth?token=eyJpdiI6..."
}

Authorizations

​
Authorization
string
header
required

Autenticazione tramite chiave API. Fornisci il tuo token nell'header 'Authorization'. Esempio: Authorization: Bearer <TUO_TOKEN>

Body

application/json
​
name
string
required

Un nome leggibile per l'istanza.

Example:

"WiFi Ospiti Ufficio Principale"

​
strategy
enum<string>
required

Il metodo di autenticazione per questo captive portal.

Opzioni disponibili:
oauth2,
coupon
Example:

"oauth2"

​
session_ttl
integer
required

La durata in secondi per cui la sessione di un utente rimane attiva dopo l'autenticazione. Minimo 1200, massimo 604800.

Example:

43200

​
auth_integration_id
string<uuid> | null

Richiesto se la strategia è 'oauth2'. L'ID di un'integrazione di autenticazione pre-configurata.

Example:

"c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f"

Response

L'istanza captive portal è stata creata con successo.

​
id
string<uuid>

L'identificatore univoco per l'istanza.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

​
auth_integration_id
string<uuid> | null

L'ID dell'integrazione di autenticazione utilizzata se la strategia è 'oauth2'. Nullo per la strategia 'coupon'.

Example:

"c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f"

​
strategy
enum<string>

Il metodo di autenticazione per questo captive portal.

Opzioni disponibili:
oauth2,
coupon
Example:

"oauth2"

​
name
string

Un nome leggibile per l'istanza.

Example:

"WiFi Ospiti Ufficio Principale"

​
session_ttl
integer

La durata in secondi per cui la sessione di un utente rimane attiva dopo l'autenticazione avvenuta con successo.

Example:

43200

​
auth_window_ttl
integer

Per la strategia OAuth2, la durata in secondi per cui il walled garden viene temporaneamente aperto per consentire all'utente di completare l'autenticazione con il provider di identità.

Example:

300

​
theme
object

Una raccolta di impostazioni di branding e aspetto.

​
terms_text
string | null

Il testo dei termini e delle condizioni che può essere mostrato all'utente.

Example:

"Connettendoti, accetti i nostri termini di servizio..."

​
sites
object[]

Un elenco di sedi e delle loro sottoreti in cui questa istanza captive portal è attiva.

​
created_at
string<date-time>

Il timestamp di creazione dell'istanza.

Example:

"2025-10-29T12:00:00Z"

​
preview_url
string<uri> | null

Un URL temporaneo e firmato per visualizzare in anteprima l'aspetto del captive portal.

Example:

"https://captive.altostr.at/preauth?token=eyJpdiI6..."