Criar um novo contacto

POST https://api.lws.net/v1/contact

operationIdpostContact

Cria um novo contacto, gerido pela sua conta, que poderá depois ser utilizado para se ligar aos nossos serviços. Deixar o campo empresa em branco criará um contacto individual.

Corpo do pedido

application/json

company any

Nome da empresa (opcional)

Exemplo: Minha Empresa

opcional
lastname any

Apelido

Exemplo: Silva

opcional
firstname any

Primeiro nome

Exemplo: João

opcional
address any

Morada

Exemplo: 1 rue de la Paix

opcional
postal string

Código postal

Exemplo: 75000

opcional
city any

Cidade

Exemplo: Paris

opcional
country any

País

Exemplo: FR

opcional
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

opcional
email any

Endereço de email

Exemplo: [email protected]

opcional
password any

Palavra-passe

Exemplo: password

opcional

Exemplo de pedido

{
  "company": "Minha Empresa",
  "lastname": "Silva",
  "firstname": "João",
  "address": "1 rue de la Paix",
  "postal": "75000",
  "city": "Paris",
  "country": "FR",
  "phone": "0033612345678",
  "email": "[email protected]",
  "password": "password"
}

Respostas

200

Contacto criado com sucesso

{
  "code": 200,
  "info": "Contact successfully created",
  "data": "367228"
}

Campos da resposta 3

code integer

Exemplo: 200
info string

Exemplo: Contact successfully created
data string

ID do contacto recém-criado. Permite obter as suas informações através de um pedido GET

Exemplo: 367228

400

Parâmetros inválidos ou contacto duplicado

{
  "code": 400,
  "info": {
    "email": "Invalid email address format. Example: [email protected]",
    "phone": "Required field"
  },
  "data": {
    "email": "Email regex pattern",
    "phone": "Phone number regex pattern"
  }
}

Campos da resposta 3

code integer

Exemplo: 400
info object

Exemplo: {"email":"Invalid email address format. Example: [email protected]","phone":"Required field"}
data object

Exemplo: {"email":"Email regex pattern","phone":"Phone number regex pattern"}

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

{
  "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"}

1LWS_AUTH_LOGIN='…'2LWS_AUTH_PASS='…'34curl -X POST \5 "https://api.lws.net/v1/contact" \6 -H "X-Auth-Login: $LWS_AUTH_LOGIN" \7 -H "X-Auth-Pass: $LWS_AUTH_PASS" \8 -H "Content-Type: application/json" \9 -d '{"company":"Minha Empresa","lastname":"Silva","firstname":"João","address":"1 rue de la Paix","postal":"75000","city":"Paris","country":"FR","phone":"0033612345678","email":"[email protected]","password":"password"}'

1$lwsAuthLogin = '…';2$lwsAuthPass = '…';34$ch = curl_init("https://api.lws.net/v1/contact");5curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");6curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);7curl_setopt($ch, CURLOPT_HTTPHEADER, [8 "X-Auth-Login: " . $lwsAuthLogin,9 "X-Auth-Pass: " . $lwsAuthPass,10 "Content-Type: application/json",11]);12curl_setopt($ch, CURLOPT_POSTFIELDS, '{"company":"Minha Empresa","lastname":"Silva","firstname":"João","address":"1 rue de la Paix","postal":"75000","city":"Paris","country":"FR","phone":"0033612345678","email":"[email protected]","password":"password"}');1314$res = json_decode(curl_exec($ch), true);

1import requests23LWS_AUTH_LOGIN = "…"4LWS_AUTH_PASS = "…"56res = requests.post(7 "https://api.lws.net/v1/contact",8 headers={9 "X-Auth-Login": LWS_AUTH_LOGIN,10 "X-Auth-Pass": LWS_AUTH_PASS,11 },12 json={"company": "Minha Empresa", "lastname": "Silva", "firstname": "João", "address": "1 rue de la Paix", "postal": "75000", "city": "Paris", "country": "FR", "phone": "0033612345678", "email": "[email protected]", "password": "password"},13)14print(res.json())

1const LWS_AUTH_LOGIN = "…";2const LWS_AUTH_PASS = "…";34const res = await fetch("https://api.lws.net/v1/contact", {5 method: "POST",6 headers: {7 "X-Auth-Login": LWS_AUTH_LOGIN,8 "X-Auth-Pass": LWS_AUTH_PASS,9 "Content-Type": "application/json",10 },11 body: JSON.stringify({"company":"Minha Empresa","lastname":"Silva","firstname":"João","address":"1 rue de la Paix","postal":"75000","city":"Paris","country":"FR","phone":"0033612345678","email":"[email protected]","password":"password"}),12});13const data = await res.json();

1lwsAuthLogin := "…"2lwsAuthPass := "…"34body := strings.NewReader(`{"company":"Minha Empresa","lastname":"Silva","firstname":"João","address":"1 rue de la Paix","postal":"75000","city":"Paris","country":"FR","phone":"0033612345678","email":"[email protected]","password":"password"}`)5req, _ := http.NewRequest("POST",6 "https://api.lws.net/v1/contact", body)7req.Header.Set("X-Auth-Login", lwsAuthLogin)8req.Header.Set("X-Auth-Pass", lwsAuthPass)9req.Header.Set("Content-Type", "application/json")1011resp, err := http.DefaultClient.Do(req)

Criar um novo contacto

Corpo do pedido

Respostas

Comunicar um erro

Assistente IA