Cadastrar um cliente

Isto se faz uma vez por cliente, e depois não se mexe mais. São dois passos e uma decisão.

1 · você declara a ficha dele   POST /customers        → você escolhe o clientRef dele
2 · você conecta a conta dele   ← aqui está a bifurcação: depende do portal
3 · (opcional) você confere      GET /customers        gratuito

1 · A ficha

POST /customers com os dados da imobiliária.

O que você decide aqui é o clientRef, e é a decisão que vai usar mais: é como você nos diz de que cliente está falando em cada chamada posterior. Quem o escolhe é você — use o id que esse cliente já tem no seu sistema. Não o geramos de propósito, justamente para que você não tenha que manter uma tabela de equivalências.

A ficha inclui os dados de contato que vão sair publicados no anúncio. Não é administrativo: é o que a pessoa que faz a consulta vê. Uma ficha sem telefone publica um anúncio sem telefone.

2 · Conectar a conta dele no portal — a bifurcação

Há duas formas e não é você quem escolhe: quem define é o portal.

Com um linkCom a credencial
Quem autorizao seu cliente, abrindo um linkvocê, com a credencial que já conseguiu
Você administra uma credencial delenãosim
O que você nos mandanada: pede o link e o repassaa credencial da conta dele
PortaisZonapropArgenprop · Cabaprop · MercadoLibre

Por que existem as duas: alguns portais não emitem nenhuma credencial por conta — a imobiliária entra, aceita, e a autorização fica do lado deles. Nesses não há nada que você possa guardar, e por isso o caminho é o link.

⚠️ Não são intercambiáveis. Se você tentar registrar uma credencial num portal que vai por link, dizemos isso com o nome do portal e com o link para pedi-lo. Não é um erro seu de permissões: é o caminho errado para esse portal.

A tabela completa de qual portal vai por onde está em Publicação.

3 · Verificar que ficou pronto (gratuito)

GET /customers devolve a ficha e, ao lado, o estado das conexões dele. Não custa nada, então é a forma barata de confirmar antes de começar a publicar.

Nos portais que têm planos de publicação, aqui também vêm os planos do seu cliente — e isso é gratuito porque os trazemos na mesma chamada com a qual verificamos que ele autorizou. Não é preciso pedi-los à parte.

O que NÃO fazer no cadastro

  • Gerar um clientRef nosso. Quem o escolhe é você; use o seu.
  • Pedir os planos ao portal. Você já os tem a partir do passo 3, gratuitos e com a data.
  • Mapear as zonas dele. Nós as resolvemos; você manda a sua.
  • Esperar ter a conta conectada para começar a integrar. O verificador funciona igual sem conexão, então você pode deixar o seu mapeamento do objeto pronto antes de o seu cliente autorizar.

Se o seu aplicativo conecta um único cliente

O clientRef já está fixado do nosso lado: a ficha é uma e não é preciso nos dizer qual em cada chamada. Os dois passos são os mesmos.

Relacionado