BETA

GET /branches

Devolve as filiais da imobiliária dona do token, cada uma com o seu branchId.

Uma imobiliária pode ter várias, e cada uma é uma entidade da Mapaprop com o seu próprio id. Esse id é atribuído por nós quando a filial é criada: não se deduz nem se constrói a partir do seu sistema, lê-se aqui.

Não a identifique pelo nome. Duas filiais podem ter nomes parecidos, o nome é editado no aplicativo web sem avisá-lo, e "Centro" não é "Casa Central". É o mesmo motivo pelo qual as zonas são mapeadas por id e não por texto.

Informação do recurso
Autenticação	Obrigatória (Token de API, Bearer)
Scope	`property-api-read`
HTTP Method	GET
Response	JSON
Version	1

A chamada

GET https://property-api.mapaprop.com/property-v1/branches
Authorization: Bearer {access_token}

Não leva parâmetros: o cliente sai do token.

A resposta

{
  "branches": [
    {
      "branchId": 8468,
      "main": true,
      "name": "Rodrigo Prop Test",
      "address": "Av Barce Lona 123",
      "zip": "123443",
      "phone1": "011 666 7114",
      "email": "rodrigo.asensio@mapaprop.com",
      "zone0": 1,
      "zone0Description": "Argentina",
      "zone1": 2,
      "zone1Description": "Buenos Aires",
      "zone2": 137,
      "zone2Description": "Adolfo Alsina",
      "zone3": 1137,
      "zone3Description": "Adelina Grande"
    }
  ]
}

Objeto	Campo	Tipo	Descrição
Response	`branches`	Array	As filiais da conta. Nunca vem vazio: toda conta tem pelo menos a principal
Branch	`branchId`	number	O id que você tem de usar. É o que relaciona a filial com um imóvel
	`main`	boolean	`true` na filial principal. Há exatamente uma
	`name`	string	O nome, para que uma pessoa escolha na sua tela. Não é uma chave
	`address`	string	O endereço da filial
	`zip`	string	O código postal
	`phone1` · `email`	string	O contato da filial
	`zone0` … `zone3`	number	A sua localização, nas zonas da Mapaprop
	`zone0Description` … `zone3Description`	string	As mesmas zonas em texto, para exibir. Para mapear use os ids

Quando chamá-la

Uma vez por cliente, no momento do cadastro — tal como o catálogo de zonas: você guarda o branchId junto à filial do seu sistema e fica mapeado.

Chame-a de novo se a imobiliária avisar que abriu uma filial nova.

ℹ️ Hoje o objeto do imóvel não leva a filial: branchId é um campo nosso e é ignorado se você o enviar. A filial que viaja hoje é a do cadastro do cliente, com os seus dados de contato para os portais. Este endpoint existe para que você já tenha o mapeamento feito.

Erros

Código	O que aconteceu	O que fazer
`400`	O token não corresponde a uma conta da Mapaprop (`rule: customer_not_declared`)	As filiais são de uma conta. Se os seus clientes não têm conta da Mapaprop, escreva para nós: ainda não há forma de resolver as filiais deles por este caminho
`401`	Falta o token ou não é válido	Verifique o cabeçalho `Authorization`
`403`	O token não tem o scope `property-api-read`	É uma permissão do seu token: escreva para nós
`503`	Não conseguimos lê-las neste momento	É transitório e do nosso lado: tente de novo

Relacionado

Cadastrar um cliente — o momento em que isto é lido
Zonas — o outro catálogo que se mapeia uma vez
O objeto do imóvel — que campos a Mapaprop define e quais são ignorados