GET /api/action/express-v1/settings @deprecated

DEPRECATED

Este endpoint continua operacional, mas está descontinuado: novas integrações devem usar GET /settings-v2, que retorna a configuração completa do site.

Este serviço fornece a configuração geral do site e do cliente a partir de um domínio.

Informações do recurso
Autenticação	Obrigatória (Token de API, Bearer)
Scope	`express-base`
HTTP Method	GET
Response	JSON
Version	1

URL do recurso

https://mapaprop.app/api/action/express-v1/settings

Código de exemplo

GET /api/action/express-v1/settings HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Resposta

Um documento JSON com a configuração do cliente e do site.

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	settings	Array of Setting	yes	A lista de objetos Setting
	customer	Customer	yes	O objeto Customer
Setting	name	string	yes	O nome do setting
	category	string	yes	A categoria do setting (config, resource)
Customer	name	string	yes	O nome da empresa da imobiliária
	address	string	yes	O endereço da imobiliária
	zone0Description	string	yes	O país onde a imobiliária está localizada
	zone1Description	string	yes	O estado/província onde a imobiliária está localizada
	zone2Description	string	yes	O município ou bairro onde a imobiliária está localizada
	zone3Description	string	no	A cidade onde a imobiliária está localizada
	zip	string	yes	O CEP da imobiliária
	websiteActive	boolean	yes	Se o site está ativo ou não. Se não estiver, nenhum outro serviço retornará dados. Isso pode ocorrer por faturas em atraso ou cancelamento simples
	phone1	string	yes	Um número de telefone da imobiliária
	phone2	string	no	Um número de telefone alternativo da imobiliária
	phone3	string	no	Um número de telefone alternativo da imobiliária
	mobile	string	no	Número de celular para mensagens instantâneas
	email	string	yes	O e-mail do cliente

Exemplo de resposta

{
  "settings": [
    {
      "name": "mode",
      "category": "config",
      "value": "some.branches"
    },
    {
      "name": "google.analytics",
      "category": "resource",
      "value": "UA-16637317-1"
    },
    {
      "name": "logo",
      "category": "resource",
      "value": "/styles/customers/1687/logo.png"
    },
    {
      "name": "path",
      "category": "resource",
      "value": "1687"
    },
    {
      "name": "slide1.image",
      "category": "resource",
      "value": "/styles/customers/1687/slide1.jpg"
    },
    {
      "name": "slide1.url",
      "category": "resource",
      "value": "/contacto"
    },
    {
      "name": "slide2.image",
      "category": "resource",
      "value": "/styles/customers/1687/slide2.jpg"
    },
    {
      "name": "slide2.url",
      "category": "resource",
      "value": "/contacto"
    },
    {
      "name": "slide3.image",
      "category": "resource",
      "value": "/styles/customers/1687/slide3.jpg"
    },
    {
      "name": "slide3.url",
      "category": "resource",
      "value": "/contacto"
    },
    {
      "name": "stylesheet",
      "category": "resource",
      "value": "/styles/customers/1687/style.css"
    }
  ],
  "customer": {
    "name": "Super Realtors Inc",
    "tempRental": true,
    "zone0Description": "Argentina",
    "zone1Description": "Capital Federal",
    "zone2Description": "Recoleta",
    "websiteActive": true,
    "phone1": "2334-3322",
    "phone2": "2334-3323",
    "mobile": "541122226666",
    "email": "info@fancy.com",
    "zip": "1425",
    "address": "Skype: apartments"
  }
}