Documentação da API Alojamento web acessível a todos
PT

Idioma

Français English Deutsch Español Português
Visitar a LWS
API de Domínios e E-mail

Documentação

API de Domínios e E-mail
Início da documentação

Criar redirecionamento de domínio

POST https://api.lws.net/v1/domain/{domain}/redirect

operationIdpostDomainRedirect

Cria um redirecionamento 301 (Movido permanentemente) ou 302 (Encontrado/Movido temporariamente) para o domínio especificado

Parâmetros do caminho

domain string obrigatório

Domínio para o qual criar o redirecionamento

Exemplo: example.fr

Corpo do pedido

application/json
  • type integer

    Tipo de redirecionamento (301 ou 302)

    Exemplo: 301

    obrigatório
  • redirection string

    URL para a qual redirecionar

    Exemplo: https://www.example.com

    obrigatório
Exemplo de pedido 
{
  "type": 301,
  "redirection": "https://www.example.com"
}

Respostas

200

Redirecionamento criado com sucesso

 
{
  "code": 200,
  "info": "Added a new redirection",
  "data": {
    "type": 301,
    "redirection": "https://www.example.com"
  }
}
Campos da resposta 5 Estende ApiEnvelope
  • code integer

    Código de estado/erro ao nível da aplicação (nem sempre igual ao código de estado HTTP)

    Exemplo: 200

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: Added a new redirection

  • data object

    DomainRedirect

  • type integer

    Tipo de redirecionamento a utilizar. 301 (Movido permanentemente) ou 302 (Encontrado/Movido temporariamente)

    Exemplo: 301

  • redirection string

    O URL para onde o redirecionamento será efetuado

    Exemplo: https://www.example.com

201

Não é possível adicionar o redirecionamento neste momento

 
{
  "code": 201,
  "info": "Could not add redirection",
  "data": {
    "type": 301,
    "redirection": "https://www.example.com"
  }
}
Campos da resposta 5 Estende ApiEnvelope
  • code integer

    Código de estado/erro ao nível da aplicação (nem sempre igual ao código de estado HTTP)

    Exemplo: 201

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: Could not add redirection

  • data object

    DomainRedirect

  • type integer

    Tipo de redirecionamento a utilizar. 301 (Movido permanentemente) ou 302 (Encontrado/Movido temporariamente)

    Exemplo: 301

  • redirection string

    O URL para onde o redirecionamento será efetuado

    Exemplo: https://www.example.com

314

Domínio não encontrado na conta

314 não é um código de estado HTTP registado. É específico desta API.

{
  "code": 314,
  "info": "Provided domain has not been found on your account. You must own this domain to manage it."
}
Campos da resposta 2 Estende ApiEnvelope
  • code integer

    Código de estado/erro ao nível da aplicação (nem sempre igual ao código de estado HTTP)

    Exemplo: 314

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: Provided domain has not been found on your account. You must own this domain to manage it.

400

Entrada inválida

 
{
  "code": 400,
  "info": "Invalid input",
  "data": []
}
Campos da resposta 3 Estende ApiEnvelope
  • code integer

    Código de estado/erro ao nível da aplicação (nem sempre igual ao código de estado HTTP)

    Exemplo: 400

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: Invalid input

  • data object

    Detalhes dos erros de validação

500

Erro interno do servidor

 
{
  "code": 500,
  "info": "Internal Server Error",
  "data": "string"
}
Campos da resposta 3 Estende ApiEnvelope
  • code integer

    Código de estado/erro ao nível da aplicação (nem sempre igual ao código de estado HTTP)

    Exemplo: 500

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: Internal Server Error

  • data string

    Mensagem de erro

502

Gateway inválido

 
{
  "code": 502,
  "info": "Invalid response from upstream server",
  "data": []
}
Campos da resposta 3 Estende ApiEnvelope
  • code integer

    Código de estado/erro ao nível da aplicação (nem sempre igual ao código de estado HTTP)

    Exemplo: 502

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: Invalid response from upstream server

  • data object

    Resposta inválida devolvida pelo servidor

401

Não autorizado - Faltam os cabeçalhos de autenticação

 
{
  "code": 401,
  "info": "Unauthorized access to the API. Please specify X-Auth-Pass and X-Auth-Login to proceed."
}
Campos da resposta 2
  • code integer

    Exemplo: 401

  • info string

    Exemplo: Unauthorized access to the API. Please specify X-Auth-Pass and X-Auth-Login to proceed.

429

Limite de pedidos excedido

 
{
  "code": 429,
  "info": "Rate limit exceeded. Please try again later."
}
Campos da resposta 2
  • code integer

    Exemplo: 429

  • info string

    Exemplo: Rate limit exceeded. Please try again later.

POST /domain/{domain}/redirect 
LWS_AUTH_LOGIN='…'LWS_AUTH_PASS='…'curl -X POST \  "https://api.lws.net/v1/domain/example.fr/redirect" \  -H "X-Auth-Login: $LWS_AUTH_LOGIN" \  -H "X-Auth-Pass: $LWS_AUTH_PASS" \  -H "Content-Type: application/json" \  -d '{"type":301,"redirection":"https://www.example.com"}'
$lwsAuthLogin = '…';$lwsAuthPass = '…';$ch = curl_init("https://api.lws.net/v1/domain/example.fr/redirect");curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);curl_setopt($ch, CURLOPT_HTTPHEADER, [    "X-Auth-Login: " . $lwsAuthLogin,    "X-Auth-Pass: " . $lwsAuthPass,    "Content-Type: application/json",]);curl_setopt($ch, CURLOPT_POSTFIELDS, '{"type":301,"redirection":"https://www.example.com"}');$res = json_decode(curl_exec($ch), true);
import requestsLWS_AUTH_LOGIN = "…"LWS_AUTH_PASS = "…"res = requests.post(    "https://api.lws.net/v1/domain/example.fr/redirect",    headers={        "X-Auth-Login": LWS_AUTH_LOGIN,        "X-Auth-Pass": LWS_AUTH_PASS,    },    json={"type": 301, "redirection": "https://www.example.com"},)print(res.json())
const LWS_AUTH_LOGIN = "…";const LWS_AUTH_PASS = "…";const res = await fetch("https://api.lws.net/v1/domain/example.fr/redirect", {  method: "POST",  headers: {    "X-Auth-Login": LWS_AUTH_LOGIN,    "X-Auth-Pass": LWS_AUTH_PASS,    "Content-Type": "application/json",  },  body: JSON.stringify({"type":301,"redirection":"https://www.example.com"}),});const data = await res.json();
lwsAuthLogin := "…"lwsAuthPass := "…"body := strings.NewReader(`{"type":301,"redirection":"https://www.example.com"}`)req, _ := http.NewRequest("POST",    "https://api.lws.net/v1/domain/example.fr/redirect", body)req.Header.Set("X-Auth-Login", lwsAuthLogin)req.Header.Set("X-Auth-Pass", lwsAuthPass)req.Header.Set("Content-Type", "application/json")resp, err := http.DefaultClient.Do(req)