API-Dokumentation Webhosting für alle
DE

Sprache

Français English Deutsch Español Português
LWS besuchen
Domain- & E-Mail-API

Dokumentation

Domain- & E-Mail-API
Startseite der Dokumentationen

Einen Kontakt abrufen

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

operationIdgetContact

Ruft Informationen zu einem Kontakt anhand seiner ID ab. Diese ID kann über die Aktion '/contact/0/list' ermittelt werden und wird auch bei der Kontakterstellung angegeben. Es können nur vom Benutzer verwaltete Kontakte abgerufen werden.

Pfadparameter

contact integer erforderlich

ID des gesuchten Kontakts

Beispiel: 367228

Antworten

200

Kontakt erfolgreich abgerufen

 
{
  "code": 200,
  "info": "Contact fetched",
  "data": {
    "company": "Meine Firma",
    "lastname": "Müller",
    "firstname": "Hans",
    "address": "1 rue de la Paix",
    "postal": "75000",
    "city": "Paris",
    "country": "Frankreich",
    "phone": "0033612345678",
    "email": "[email protected]",
    "is_company": true,
    "credit": 0
  }
}
Felder der Antwort 14
  • code integer

    Beispiel: 200

  • info string

    Beispiel: Contact fetched

  • data object

    Antwortschema der Kontaktinformationen

    ContactGet

  • company any

    Firmenname (optional)

    Beispiel: Meine Firma

  • lastname any

    Nachname

    Beispiel: Müller

  • firstname any

    Vorname

    Beispiel: Hans

  • address any

    Straße und Hausnummer

    Beispiel: 1 rue de la Paix

  • postal string

    Postleitzahl

    Beispiel: 75000

  • city any

    Stadt

    Beispiel: Paris

  • country any

    Land

    Beispiel: Frankreich

  • phone any

    Telefonnummer des Kontakts im internationalen Format 00{Ländercode}{Nummer}

    Muster ^00\d{1,3}\d{6,12}$ Beispiel: 0033612345678

  • email any

    E-Mail-Adresse

    Beispiel: [email protected]

  • is_company any

    Gibt an, ob der Kontakt für eine Firma ist oder nicht

    Beispiel: true

  • credit any

    Guthabenstand

    Beispiel: 0

400

Der Kontakt konnte nicht abgerufen werden. Bedeutet in der Regel, dass ein Kontakt mit dieser ID nicht existiert oder ungültig ist.

 
{
  "code": 400,
  "info": "No contact provided"
}
Felder der Antwort 2
  • code integer

    Beispiel: 400

  • info string

    Beispiel: No contact provided

401

Nicht autorisiert - Authentifizierungs-Header fehlen

 
{
  "code": 401,
  "info": "Unauthorized access to the API. Please specify X-Auth-Pass and X-Auth-Login to proceed."
}
Felder der Antwort 2
  • code integer

    Beispiel: 401

  • info string

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

429

Anfragelimit überschritten

 
{
  "code": 429,
  "info": "Rate limit exceeded. Please try again later."
}
Felder der Antwort 2
  • code integer

    Beispiel: 429

  • info string

    Beispiel: Rate limit exceeded. Please try again later.

500

Interner Serverfehler. Details zum Fehler werden in 'data' bereitgestellt

 
{
  "code": 500,
  "info": "Internal Server Error",
  "data": "Details on the error"
}
Felder der Antwort 3
  • code integer

    Beispiel: 500

  • info string

    Beispiel: Internal Server Error

  • data string

    Beispiel: Details on the error

502

Es wurde eine ungültige Antwort zurückgegeben. Bedeutet in der Regel, dass die zurückgegebenen Daten nicht erwartet wurden.

 
{
  "code": 502,
  "info": "Invalid response from upstream server",
  "data": {
    "status": 500,
    "error": "Internal Server Error"
  }
}
Felder der Antwort 3
  • code integer

    Beispiel: 502

  • info string

    Beispiel: Invalid response from upstream server

  • data any[]

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