Developer Search

Search developer docs, public resources, and endpoint references.

Get Started
Quickstart

Launch against the real Asteri surface that exists today.

The fastest path is to start with scoped keys, signed webhooks, and the in-product integration controls. The public API program is being shaped around those same primitives instead of replacing them.

1

Create an Asteri workspace

Use a normal Asteri account first. The earliest developer workflows are anchored in the existing dashboard because key creation, integration setup, and webhook controls already live there.

Create workspace
2

Generate a scoped API key

Start in Security settings, create a key with the minimum scopes you need, and set explicit expiry and rate-limit bounds for every environment.

Open security center
3

Register a webhook endpoint

Create a signed webhook endpoint, subscribe only to the event groups you need, and test delivery with your receiver before moving anything into production.

Configure webhooks
4

Pick your integration mode

Today that means signed webhooks, outbound REST automations, and catalog integrations. Public REST resources and partner OAuth clients are being added as a preview program.

Review API program
Current console surfaces

Security center: /dashboard/settings/security

Integrations catalog: /dashboard/settings/integrations

Platform team contact: /contact

This portal will eventually own the complete external program. For now, it points developers at the controls that are already reliable inside the product.

Preview lanes opening next

Public REST resources

Versioned routes for customers, appointments, estimates, invoices, and payments.

Sandbox tenants

Seeded developer accounts with realistic field-service data and safe event simulation.

Partner app program

OAuth clients, distribution review, app analytics, and change communication.

First request

Use a scoped API key and explicit org context.

The preview API expects both an API credential and a concrete organization context on every request.

curl -X GET \
  http://localhost:3000/api/public/v1/openapi.json \
  -H "x-api-key: ast_live_your_key" \
  -H "x-organization-id: ${ORG_ID}"
Before you retry

Check auth first.

401 responses usually mean the API key is wrong, expired, or not being sent the way you think it is. Confirm the value, expiry, and environment before changing application code.

Scope check

Make the key as narrow as possible.

403 responses usually mean the key is valid but missing a resource scope. Start narrow, then add only the missing scope.

Throughput

Respect rate limits from day one.

429 responses are part of the normal preview contract. Read Retry-After, slow down worker concurrency, and avoid immediate queue replays.