A Nobur, direto no seu sistema
Uma API REST e webhooks assinados para levar imóveis, propostas e contratos ao seu ERP, site ou automação.
- Incluída em todos os planos
- REST e JSON
- Webhooks assinados
$ curl -i "https://api.nobur.com.br/public/v1/brokers?limit=1" \ -H "X-API-Key: $NOBUR_API_KEY" const res = await fetch("https://api.nobur.com.br/public/v1/brokers?limit=1", { headers: { "X-API-Key": process.env.NOBUR_API_KEY },});const { items, page_info } = await res.json(); import os, requests res = requests.get( "https://api.nobur.com.br/public/v1/brokers", params={"limit": 1}, headers={"X-API-Key": os.environ["NOBUR_API_KEY"]},)page = res.json() req, _ := http.NewRequest(http.MethodGet, "https://api.nobur.com.br/public/v1/brokers?limit=1", nil)req.Header.Set("X-API-Key", os.Getenv("NOBUR_API_KEY"))res, err := http.DefaultClient.Do(req)if err != nil { log.Fatal(err)}defer res.Body.Close()body, _ := io.ReadAll(res.Body) $context = stream_context_create(["http" => [ "header" => "X-API-Key: " . getenv("NOBUR_API_KEY"),]]);$body = file_get_contents("https://api.nobur.com.br/public/v1/brokers?limit=1", false, $context);$page = json_decode($body, true); require "net/http"require "json" uri = URI("https://api.nobur.com.br/public/v1/brokers?limit=1")req = Net::HTTP::Get.new(uri)req["X-API-Key"] = ENV.fetch("NOBUR_API_KEY")res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }page = JSON.parse(res.body) var request = HttpRequest.newBuilder(URI.create("https://api.nobur.com.br/public/v1/brokers?limit=1")) .header("X-API-Key", System.getenv("NOBUR_API_KEY")) .build();var response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString());var body = response.body(); using var http = new HttpClient();http.DefaultRequestHeaders.Add("X-API-Key", Environment.GetEnvironmentVariable("NOBUR_API_KEY"));var body = await http.GetStringAsync("https://api.nobur.com.br/public/v1/brokers?limit=1");var page = JsonDocument.Parse(body); Resposta
HTTP/2 200content-type: application/jsonx-ratelimit-limit: 300x-ratelimit-remaining: 299x-ratelimit-reset: 1791729180 { "items": [ { "id": "brk_7k2m9q4xh3c8vn1tdz5r", "name": "Helena Duarte", "creci": "48213-F", "email": "helena@duarteimoveis.com.br", "visibility": "organization", "created_at": "2026-10-08T14:32:10Z", … mais 5 campos } ], "page_info": { "has_next_page": true, "total": 37, … mais 3 campos }} A API em números
-
100
itens por lote
-
24 h
de idempotência
-
300/min
por credencial
-
RFC 9457
nos erros
-
1.000+
chamadas por dia
8 recursos com CRUD, lote e webhooks. Referência na documentação Cotas por plano
Webhooks
Avisamos quando algo muda
Escolha os eventos e receba um POST no seu endpoint, assinado com HMAC-SHA256.
| Recurso | created | updated | deleted |
|---|---|---|---|
| broker | broker.created | broker.updated | broker.deleted |
| property | property.created | property.updated | property.deleted |
| listing | listing.created | listing.updated | listing.deleted |
| party | party.created | party.updated | party.deleted |
| proposal | proposal.created | proposal.updated | proposal.deleted |
| contract | contract.created | contract.updated | contract.deleted |
| document | document.created | document.updated | document.deleted |
+ webhook.ping no envio de teste
- Até 5 tentativas
- Envio de teste com tempo de resposta
- Histórico de entregas
- webhook.pingteste · 142 ms200 success
- proposal.updated14:32200 success
- contract.created14:28 · 503, nova tentativa em 1 min 14:29 · na 2ª de 5 tentativas— pending 200 success
- document.created14:21200 success
- property.updated14:08200 success
Duas credenciais, um header
Chave de API para integrações, token pessoal para os seus scripts. As duas vão em
X-API-Key.
- Papel
- editor
- Escopos
- property:view property:create proposal:view document:*
- Organização
- Matriz
- Age como
- Helena Duarte
- Organizações
- Matriz Filial Centro
- X-Organization-ID: org_…
- Expira em
- 31/12/2026
Dúvidas de quem integra
A API tem custo adicional?
Não. A API está incluída em todos os planos, inclusive no Essencial, que é gratuito.
O plano define só a cota diária de chamadas:
- Essencial: 1.000
- Profissional: 10.000
- Corporativo: 50.000
- Empresarial: Ilimitado
O uso da própria plataforma não consome essa cota.
Como a API autentica as requisições?
Pelo header X-API-Key, com uma destas credenciais:
- Chave de API (
nbr_): papel e escopos próprios, para integrações entre sistemas - Token de acesso pessoal (
pat_): age com as permissões de quem o criou
Se a credencial alcança mais de uma organização, informe qual em X-Organization-ID.
Detalhes em Autenticação.
Como sei que um webhook veio da Nobur?
Confira a assinatura antes de processar.
O header X-Webhook-Signature traz sha256= seguido de um HMAC-SHA256 do corpo, calculado com o segredo que a API devolve ao criar o webhook. Calcule o mesmo hash do seu lado e compare.
O que acontece se o meu endpoint estiver fora do ar?
A Nobur tenta de novo.
- Até 5 tentativas no total
- A primeira repetição após 1 minuto, dobrando o intervalo até 10 minutos
- Repete em respostas 5xx,
429e falhas de conexão; outras respostas 4xx não
Cada entrega fica no histórico do webhook, em GET /webhooks/{id}/deliveries.
Existe SDK ou especificação OpenAPI?
Não há SDK oficial, mas há especificação OpenAPI 3.1.
Ela está publicada em openapi/v1.yaml, e dela dá para gerar um cliente na linguagem que você usa.
Gere a sua primeira chave hoje
Crie a conta, abra as configurações e faça a primeira chamada. Sem cartão de crédito.