Skip to main content

SDKs

We do not ship an official SDK at v1 launch (2026-05-29). Instead we publish a machine-readable contract that any mainstream code generator can consume, plus a hand-curated Postman collection for exploration:

  • OpenAPI specification: https://valara.cloud/api/openapi.json (legacy alias: https://dash.jacoballenmedia.com/api/openapi.json). This is the authoritative contract. Every field on every auto-generated endpoint page is derived from this spec.
  • Postman collection + environment: postman/README.md in the Dashboard-Real-Estate repo. Import the collection, fill in your VALARA_API_KEY, send the first request.
  • Webhook catalog: GET /api/v1/webhooks/events returns a JSON payload whose payload_schema blocks are JSON Schema objects that feed into quicktype, datamodel-code-generator, and similar tools.

Generating an unofficial SDK​

The OpenAPI spec and the webhook catalog give you enough contract material to generate a typed client in almost any language. Two common approaches:

With openapi-generator (multi-language)​

openapi-generator supports 60+ language targets. It is Apache-licensed and widely deployed.

# Install once (requires Java 11+).
npm install -g @openapitools/openapi-generator-cli

# Python client
openapi-generator-cli generate \
  -i https://valara.cloud/api/openapi.json \
  -g python \
  -o ./valara-client-python

# TypeScript / fetch client
openapi-generator-cli generate \
  -i https://valara.cloud/api/openapi.json \
  -g typescript-fetch \
  -o ./valara-client-ts

# Go client
openapi-generator-cli generate \
  -i https://valara.cloud/api/openapi.json \
  -g go \
  -o ./valara-client-go

With openapi-typescript (TypeScript only)​

openapi-typescript emits pure TypeScript types (no runtime client). Pair it with openapi-fetch or your preferred HTTP client for a minimal footprint.

npm install --save-dev openapi-typescript
npx openapi-typescript https://valara.cloud/api/openapi.json \
  --output ./src/generated/valara.d.ts

What a community SDK should cover​

A complete community SDK should ship:

  1. Typed clients for all 10 public endpoints. Generated directly from the OpenAPI spec.
  2. An HMAC-SHA256 verifier that matches the bit-exact recipe on the webhook overview page. Include the known test vector as a unit test.
  3. Replay protection helpers that reject deliveries whose timestamp is more than 5 minutes off the local clock and whose nonce has been consumed in the last 10 minutes. Redis or any TTL-supporting store works for the nonce cache.
  4. Retry / back-off logic for 429 responses: honour Retry-After with exponential jitter (recommended schedule delay = Retry-After + random(0, 5)).
  5. Automatic X-Idempotency-Key injection on all POST/PATCH mutations. Most developers forget this header on retries.
  6. Canonical error envelope parsing. Switch on error.code (not the English error.message) per the error codes page.

Contributing an SDK​

Community SDKs are welcome. Add your library to this page via a pull request against Dashboard-Real-Estate. Include:

  • Repository URL.
  • Language and target runtime.
  • Maintainer contact.
  • Confirmation that the SDK passes the HMAC test vector on the webhook overview page.

Compatibility pledge​

We will NOT break the OpenAPI contract within the v1 major version. Additive changes (new fields, new event types, new endpoints) ship under /api/v1/; breaking changes ship under the next major (/api/v2/) with a 12-month overlap so community SDKs have a quarter to catch up.

For early visibility, subscribe to the changelog: email support@valara.cloud with the subject "subscribe api changelog" and we will include you on every release email before GA.