Conta

A conta dona da chave: plano, cota de imóveis, permissões da chave, limites e o uso do mês.

GET/v1/me— Quem sou eu

As rotas

GET/v1/me

Quem sou eu

A primeira chamada de toda integração: confirma que a chave vale e mostra a conta, as permissões desta chave, os limites e o uso do mês.

Permissão: qualquer chave válida

Resposta200OK

dataMeobrigatório: Conta.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/me' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

Os objetos

Limits

Os limites da faixa de uso da conta.

ratePerSecondintegerobrigatório: Chamadas por segundo.
burstintegerobrigatório: Pico tolerado num instante.
monthlyQuotaintegerobrigatório: Chamadas por mês (mês de calendário, UTC).
maxKeysintegerobrigatório: Chaves ativas ao mesmo tempo.
maxWebhooksintegerobrigatório: Endereços de webhook.

Me

Quem é a conta, o que a chave pode fazer e quanto da cota já foi usado.

accountobjetoobrigatório: A conta dona da chave.
account.idstringobrigatório: Id da conta.
account.namestringobrigatóriopode vir nulo: Nome da empresa.
account.typestringobrigatóriopode vir nulo: IMOBILIARIA ou CONSTRUTORA.
account.planstringobrigatóriopode vir nulo: Código do plano.
accessobjetoobrigatório: A liberação da API.
access.statusstringobrigatóriopode vir nulo: Estado da liberação (APPROVED quando vale).
access.tierstringobrigatório: Faixa de uso: PADRAO ou AMPLIADA.
access.pilotUntilstringobrigatóriopode vir nulo: Fim do período de piloto, quando houver.
access.limitsLimitsobrigatório: Os limites que valem para a conta.
keyobjetoobrigatório: A chave usada nesta chamada.
key.idstringobrigatóriopode vir nulo: Id da chave (não é o segredo).
key.namestringobrigatóriopode vir nulo: Nome dado no painel.
key.scopeslista de stringobrigatório: As permissões que valem para ESTA chave.um de properties:read properties:write leads:read leads:write radar:read radar:write partnerships:read partnerships:write team:read launches:read launches:write captacao:read captacao:accept events:read webhooks:manage
key.expiresAtstringobrigatóriopode vir nulo: Quando a chave vence (sem prazo = nulo).
usageobjetoobrigatório: O uso do mês.
usage.monthstringobrigatório: O mês (AAAA-MM, UTC).
usage.callsintegerobrigatório: Chamadas feitas no mês.
usage.monthlyQuotaintegerobrigatório: A cota do mês.
usage.remainingintegerobrigatório: O que ainda cabe.
propertiesobjetoobrigatório: A cota de imóveis do plano.
properties.activeintegerobrigatório: Imóveis ativos agora.
properties.limitintegerobrigatóriopode vir nulo: Teto de imóveis ativos do plano.