PROD

Este serviço retorna as informações do cliente com base no e-mail.

Informações do recurso
AutenticaçãoObrigatória
Scopecustomer
Método HTTPGET
RespostaJSON
Versão1

URL do recurso

https://mapaprop.app/api/action/customer-v1/{email}

Parâmetros

ChaveTipoObrigatórioDescrição
emailstringsimUm endereço de e-mail válido

Código de exemplo

GET /api/action/customer-v1/some@email.com HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Resposta

Um objeto cliente com os dados da conta.

ObjetoCampoTipoObrigatórioDescrição
ResponsenamestringsimO nome do cliente (imobiliária)
agencyIdstringsimO ID da imobiliária. Mesmo formato usado na Feeds API (por exemplo para submit-question)
addressstringsimO endereço do cliente

Códigos de erro

ErroCausa
NOT_FOUNDNão existe nenhum cliente ativo para esse e-mail

Código de exemplo

{
    "agencyId": "ECID0033201EN",
    "name": "Savio Realty",
    "address": "4555 West Friendly Avenue"
}