Documentación de la API El alojamiento web accesible para todos
ES

Idioma

Français English Deutsch Español Português
Visitar LWS
API Dominios y Correo

Documentación

API Dominios y Correo
Inicio de la documentación

Obtener un contacto

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

operationIdgetContact

Obtiene información sobre un contacto mediante su ID. Dicho ID puede encontrarse usando la acción '/contact/0/list' y también se proporciona al crear el contacto. Solo se pueden obtener los contactos gestionados por el usuario.

Parámetros de ruta

contact integer obligatorio

ID del contacto que se busca

Ejemplo: 367228

Respuestas

200

Contacto obtenido correctamente

 
{
  "code": 200,
  "info": "Contact fetched",
  "data": {
    "company": "Mi Empresa",
    "lastname": "García",
    "firstname": "Juan",
    "address": "1 rue de la Paix",
    "postal": "75000",
    "city": "Paris",
    "country": "Francia",
    "phone": "0033612345678",
    "email": "[email protected]",
    "is_company": true,
    "credit": 0
  }
}
Campos de la respuesta 14
  • code integer

    Ejemplo: 200

  • info string

    Ejemplo: Contact fetched

  • data object

    Esquema de respuesta de la información de contacto

    ContactGet

  • company any

    Nombre de la empresa (opcional)

    Ejemplo: Mi Empresa

  • lastname any

    Apellido

    Ejemplo: García

  • firstname any

    Nombre

    Ejemplo: Juan

  • address any

    Dirección postal

    Ejemplo: 1 rue de la Paix

  • postal string

    Código postal

    Ejemplo: 75000

  • city any

    Ciudad

    Ejemplo: Paris

  • country any

    País

    Ejemplo: Francia

  • phone any

    Número de teléfono del contacto en formato internacional 00{código de país}{número}

    patrón ^00\d{1,3}\d{6,12}$ Ejemplo: 0033612345678

  • email any

    Dirección de correo electrónico

    Ejemplo: [email protected]

  • is_company any

    Indica si el contacto es para una empresa o no

    Ejemplo: true

  • credit any

    Saldo de crédito

    Ejemplo: 0

400

Error al obtener el contacto. Generalmente significa que no existe un contacto con dicho ID o que no es válido.

 
{
  "code": 400,
  "info": "No contact provided"
}
Campos de la respuesta 2
  • code integer

    Ejemplo: 400

  • info string

    Ejemplo: No contact provided

401

No autorizado - Faltan las cabeceras de autenticación

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

    Ejemplo: 401

  • info string

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

429

Límite de solicitudes excedido

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

    Ejemplo: 429

  • info string

    Ejemplo: Rate limit exceeded. Please try again later.

500

Error interno del servidor. Los detalles del error se proporcionarán en 'data'

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

    Ejemplo: 500

  • info string

    Ejemplo: Internal Server Error

  • data string

    Ejemplo: Details on the error

502

Se devolvió una respuesta no válida. Generalmente significa que los datos devueltos no eran los esperados.

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

    Ejemplo: 502

  • info string

    Ejemplo: Invalid response from upstream server

  • data any[]

    Ejemplo: {"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)