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 todos los contactos gestionados por el usuario

GET https://api.lws.net/v1/contact/0/list

operationIdget0List

Obtiene un array asociativo [ID => {datos}] de todos los contactos gestionados por el usuario.

Respuestas

200

Lista de contactos obtenida correctamente

 
{
  "code": 200,
  "info": "Customer list 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 3
  • code integer

    Ejemplo: 200

  • info string

    Ejemplo: Customer list fetched

  • data object[][]

    Array asociativo $key=>$value donde $key es el ID y $value la información del contacto

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.

404

No se encontraron contactos. Puede deberse a un error o a que el usuario no gestiona ningún contacto

 
{
  "code": 404,
  "info": "No contacts could be fetched",
  "data": []
}
Campos de la respuesta 3
  • code integer

    Ejemplo: 404

  • info string

    Ejemplo: No contacts could be fetched

  • data any[]
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

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