Documentation API L’hébergement web accessible à tous Visiter LWS

Récupérer un contact

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

operationIdgetContact

Récupère des informations sur un contact à l'aide de son ID. Cet ID peut être obtenu via l'action '/contact/0/list' et est également fourni à la création du contact. Seuls les contacts gérés par l'utilisateur peuvent être récupérés.

Paramètres du chemin

contact integer requis

ID du contact recherché

Exemple: 367228

Réponses

200

Contact récupéré avec succès

{
  "code": 200,
  "info": "Contact fetched",
  "data": {
    "company": "Ma Société",
    "lastname": "Dupont",
    "firstname": "Jean",
    "address": "1 rue de la Paix",
    "postal": "75000",
    "city": "Paris",
    "country": "France",
    "phone": "0033612345678",
    "email": "[email protected]",
    "is_company": true,
    "credit": 0
  }
}
Champs de la réponse 14
  • code integer

    Exemple: 200

  • info string

    Exemple: Contact fetched

  • data object

    Schéma de réponse des informations de contact

    ContactGet

  • company any

    Nom de l'entreprise (optionnel)

    Exemple: Ma Société

  • lastname any

    Nom de famille

    Exemple: Dupont

  • firstname any

    Prénom

    Exemple: Jean

  • address any

    Adresse postale

    Exemple: 1 rue de la Paix

  • postal string

    Code postal

    Exemple: 75000

  • city any

    Ville

    Exemple: Paris

  • country any

    Pays

    Exemple: France

  • phone any

    Numéro de téléphone du contact au format international 00{code pays}{numéro}

    motif ^00\d{1,3}\d{6,12}$ Exemple: 0033612345678

  • email any

    Adresse email

    Exemple: [email protected]

  • is_company any

    Indique si le contact est pour une entreprise ou non

    Exemple: true

  • credit any

    Solde de crédit

    Exemple: 0

400

Échec de la récupération du contact. Signifie généralement qu'un contact avec cet ID n'existe pas ou n'est pas valide.

{
  "code": 400,
  "info": "No contact provided"
}
Champs de la réponse 2
  • code integer

    Exemple: 400

  • info string

    Exemple: No contact provided

401

Non autorisé - En-têtes d'authentification manquants

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

    Exemple: 401

  • info string

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

429

Limite de requêtes dépassée

{
  "code": 429,
  "info": "Rate limit exceeded. Please try again later."
}
Champs de la réponse 2
  • code integer

    Exemple: 429

  • info string

    Exemple: Rate limit exceeded. Please try again later.

500

Erreur interne du serveur. Les détails de l'erreur seront fournis dans 'data'

{
  "code": 500,
  "info": "Internal Server Error",
  "data": "Details on the error"
}
Champs de la réponse 3
  • code integer

    Exemple: 500

  • info string

    Exemple: Internal Server Error

  • data string

    Exemple: Details on the error

502

Réponse invalide retournée. Signifie généralement que les données retournées n'étaient pas attendues.

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

    Exemple: 502

  • info string

    Exemple: Invalid response from upstream server

  • data any[]

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

Afficher les exemples de code et la console de test
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)