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

Obter informações de um domínio

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

operationIdgetDomain

Obtém informações detalhadas sobre o domínio especificado, como o seu proprietário, estado, zona DNS, e mais.

Parâmetros do caminho

domain string obrigatório

Nome de domínio cujas informações se pretende obter

máx. 255 caracteres Exemplo: example.fr

Respostas

200

Informações do domínio obtidas com sucesso

 
{
  "code": 200,
  "info": "Fetched domain",
  "data": {
    "domain": "example.com",
    "dns1": "ns1.lwsdns.com",
    "dns2": "ns2.lwsdns.com",
    "dns3": "ns3.lwsdns.com",
    "dns4": "ns4.lwsdns.com",
    "owner": "358240",
    "redemption": "0",
    "clientHold": "1",
    "clientTransferProhibited": "1",
    "serverHold": "0"
  }
}
Campos da resposta 13 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: Fetched domain

  • data object

    DomainGet

  • domain string

    Nome de domínio

    Exemplo: example.com

  • dns1 string

    Primeiro DNS do domínio

    Exemplo: ns1.lwsdns.com

  • dns2 string

    Segundo DNS do domínio

    Exemplo: ns2.lwsdns.com

  • dns3 string

    Terceiro DNS do domínio

    Exemplo: ns3.lwsdns.com

  • dns4 string

    Quarto DNS do domínio

    Exemplo: ns4.lwsdns.com

  • owner string

    ID do atual proprietário do domínio

    Exemplo: 358240

  • redemption string

    Estado de resgate do domínio. '1' indica que o domínio está em período de resgate (expirado mas renovável), '0' indica estado normal.

    Exemplo: 0

  • clientHold string

    Estado de ativação do domínio. '1' significa ativo, '0' significa inativo (normalmente devido a expiração).

    Exemplo: 1

  • clientTransferProhibited string

    Estado de bloqueio de transferência. '1' indica que a transferência está proibida, '0' indica que as transferências são permitidas.

    Exemplo: 1

  • serverHold string

    Indica se o domínio está bloqueado pelo registrador (por exemplo, por motivos legais ou DNS não conforme). '1' significa bloqueado, '0' significa ativo.

    Exemplo: 0

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

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.

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} 
LWS_AUTH_LOGIN='…'LWS_AUTH_PASS='…'curl -X GET \  "https://api.lws.net/v1/domain/example.fr" \  -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");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",    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", {  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", nil)req.Header.Set("X-Auth-Login", lwsAuthLogin)req.Header.Set("X-Auth-Pass", lwsAuthPass)resp, err := http.DefaultClient.Do(req)