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

Verificar a disponibilidade de um domínio

GET https://api.lws.net/v1/domain/{domain}/availability

operationIdgetDomainAvailability

Verifica se um nome de domínio indicado está disponível para registo.

Parâmetros do caminho

domain string obrigatório

Nome de domínio cuja disponibilidade se pretende verificar

máx. 255 caracteres Exemplo: example.fr

Respostas

200

Verificação da disponibilidade do domínio efetuada com sucesso

 
{
  "code": 200,
  "info": "Domain is available for registration",
  "data": true
}
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: 200

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: Domain is available for registration

  • data boolean

    true se o domínio estiver disponível, false caso contrário

    Exemplo: true

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": "No domain provided"
}
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: 400

  • info string

    Mensagem legível que descreve o resultado do pedido

    Exemplo: No domain provided

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 detalhada sobre o 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.

GET /domain/{domain}/availability 
LWS_AUTH_LOGIN='…'LWS_AUTH_PASS='…'curl -X GET \  "https://api.lws.net/v1/domain/example.fr/availability" \  -H "X-Auth-Login: $LWS_AUTH_LOGIN" \  -H "X-Auth-Pass: $LWS_AUTH_PASS"
$lwsAuthLogin = '…';$lwsAuthPass = '…';$ch = curl_init("https://api.lws.net/v1/domain/example.fr/availability");curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);curl_setopt($ch, CURLOPT_HTTPHEADER, [    "X-Auth-Login: " . $lwsAuthLogin,    "X-Auth-Pass: " . $lwsAuthPass,]);$res = json_decode(curl_exec($ch), true);
import requestsLWS_AUTH_LOGIN = "…"LWS_AUTH_PASS = "…"res = requests.get(    "https://api.lws.net/v1/domain/example.fr/availability",    headers={        "X-Auth-Login": LWS_AUTH_LOGIN,        "X-Auth-Pass": LWS_AUTH_PASS,    },)print(res.json())
const LWS_AUTH_LOGIN = "…";const LWS_AUTH_PASS = "…";const res = await fetch("https://api.lws.net/v1/domain/example.fr/availability", {  method: "GET",  headers: {    "X-Auth-Login": LWS_AUTH_LOGIN,    "X-Auth-Pass": LWS_AUTH_PASS,  },});const data = await res.json();
lwsAuthLogin := "…"lwsAuthPass := "…"req, _ := http.NewRequest("GET",    "https://api.lws.net/v1/domain/example.fr/availability", nil)req.Header.Set("X-Auth-Login", lwsAuthLogin)req.Header.Set("X-Auth-Pass", lwsAuthPass)resp, err := http.DefaultClient.Do(req)