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 um contacto

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

operationIdgetContact

Obtém informações sobre um contacto através do seu ID. Esse ID pode ser encontrado através da ação '/contact/0/list' e é também fornecido na criação do contacto. Só podem ser obtidos contactos geridos pelo utilizador.

Parâmetros do caminho

contact integer obrigatório

ID do contacto procurado

Exemplo: 367228

Respostas

200

Contacto obtido com sucesso

 
{
  "code": 200,
  "info": "Contact fetched",
  "data": {
    "company": "Minha Empresa",
    "lastname": "Silva",
    "firstname": "João",
    "address": "1 rue de la Paix",
    "postal": "75000",
    "city": "Paris",
    "country": "França",
    "phone": "0033612345678",
    "email": "[email protected]",
    "is_company": true,
    "credit": 0
  }
}
Campos da resposta 14
  • code integer

    Exemplo: 200

  • info string

    Exemplo: Contact fetched

  • data object

    Esquema de resposta das informações de contacto

    ContactGet

  • company any

    Nome da empresa (opcional)

    Exemplo: Minha Empresa

  • lastname any

    Apelido

    Exemplo: Silva

  • firstname any

    Primeiro nome

    Exemplo: João

  • address any

    Morada

    Exemplo: 1 rue de la Paix

  • postal string

    Código postal

    Exemplo: 75000

  • city any

    Cidade

    Exemplo: Paris

  • country any

    País

    Exemplo: França

  • phone any

    Número de telefone do contacto no formato internacional 00{código do país}{número}

    padrão ^00\d{1,3}\d{6,12}$ Exemplo: 0033612345678

  • email any

    Endereço de email

    Exemplo: [email protected]

  • is_company any

    Indica se o contacto é para uma empresa ou não

    Exemplo: true

  • credit any

    Saldo de crédito

    Exemplo: 0

400

Falha ao obter o contacto. Significa geralmente que não existe um contacto com esse ID ou que não é válido.

 
{
  "code": 400,
  "info": "No contact provided"
}
Campos da resposta 2
  • code integer

    Exemplo: 400

  • info string

    Exemplo: No contact provided

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.

500

Erro interno do servidor. Os detalhes do erro serão fornecidos em 'data'

 
{
  "code": 500,
  "info": "Internal Server Error",
  "data": "Details on the error"
}
Campos da resposta 3
  • code integer

    Exemplo: 500

  • info string

    Exemplo: Internal Server Error

  • data string

    Exemplo: Details on the error

502

Foi devolvida uma resposta inválida. Significa geralmente que os dados devolvidos não eram os esperados.

 
{
  "code": 502,
  "info": "Invalid response from upstream server",
  "data": {
    "status": 500,
    "error": "Internal Server Error"
  }
}
Campos da resposta 3
  • code integer

    Exemplo: 502

  • info string

    Exemplo: Invalid response from upstream server

  • data any[]

    Exemplo: {"status":500,"error":"Internal Server Error"}

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