Pular para o conteúdo principal
POST
/
instances
Criar uma instância de portal cativo
curl --request POST \
  --url https://api.altostrat.io/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Wi-Fi de Convidados do Escritório Principal",
  "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": "Wi-Fi de Convidados do Escritório Principal",
  "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": "Ao se conectar, você concorda com nossos termos de serviço...",
  "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

Autenticação por Chave de API (API Key). Forneça seu token no cabeçalho 'Authorization'. Exemplo: Authorization: Bearer <SEU_TOKEN>

Body

application/json
​
name
string
required

Um nome legível para a instância.

Example:

"Wi-Fi de Convidados do Escritório Principal"

​
strategy
enum<string>
required

O método de autenticação para este portal cativo.

Opções disponíveis:
oauth2,
coupon
Example:

"oauth2"

​
session_ttl
integer
required

A duração em segundos que a sessão de um usuário permanece ativa após a autenticação. Mínimo 1200, máximo 604800.

Example:

43200

​
auth_integration_id
string<uuid> | null

Obrigatório se a estratégia for 'oauth2'. O ID de uma integração de autenticação pré-configurada.

Example:

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

Response

A instância do portal cativo foi criada com sucesso.

​
id
string<uuid>

O identificador único para a instância.

Example:

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

​
auth_integration_id
string<uuid> | null

O ID da integração de autenticação usada se a estratégia for 'oauth2'. Nulo para a estratégia 'coupon'.

Example:

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

​
strategy
enum<string>

O método de autenticação para este portal cativo.

Opções disponíveis:
oauth2,
coupon
Example:

"oauth2"

​
name
string

Um nome legível para a instância.

Example:

"Wi-Fi de Convidados do Escritório Principal"

​
session_ttl
integer

A duração em segundos que a sessão de um usuário permanece ativa após a autenticação bem-sucedida.

Example:

43200

​
auth_window_ttl
integer

Para a estratégia OAuth2, a duração em segundos que o walled garden é temporariamente aberto para permitir que o usuário complete a autenticação com o provedor de identidade.

Example:

300

​
theme
object

Uma coleção de configurações de marca e aparência.

​
terms_text
string | null

O texto dos termos e condições que pode ser exibido ao usuário.

Example:

"Ao se conectar, você concorda com nossos termos de serviço..."

​
sites
object[]

Uma lista de sites e suas sub-redes onde esta instância de portal cativo está ativa.

​
created_at
string<date-time>

O carimbo de data/hora de quando a instância foi criada.

Example:

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

​
preview_url
string<uri> | null

Uma URL temporária e assinada para pré-visualizar a aparência do portal cativo.

Example:

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