Skip to content

Environments

Use separate environments when integrating the partner API into your own backend or operational systems.

These are API environments for B2B integrations, not the public checkname.ch website experience.

Environment matrix

Environment Base URL Swagger / OpenAPI UI Purpose
Sandbox https://api.test.checkname.ch https://api.test.checkname.ch/docs Integration testing and pre-production validation
Production https://api.checkname.ch https://api.checkname.ch/docs Live partner traffic

Required client configuration

  • Configure a unique API key per environment.
  • Set request timeout and retry policy in your HTTP client.
  • Persist traceId on every response.
  • If your logging stack is header-oriented, also capture X-Trace-Id, which mirrors the same identifier.
  • Monitor 4xx/5xx error rates and latency percentiles.

Suggested environment variables

CHECKNAME_API_BASE_URL=https://api.test.checkname.ch
CHECKNAME_API_KEY=<sandbox-or-production-key>

Keep sandbox and production values separate and switch them together.

Retry and timeout posture

  • Do not retry unchanged 400 or 422 requests.
  • Treat 401 as a configuration or credential problem, not a retry case.
  • For 429, respect Retry-After before retrying gradually.
  • For transient 5xx responses, use bounded backoff with jitter.
  • Choose a client timeout that fits your own workflow and user experience, then keep it consistent across environments.

Logging fields to capture

  • environment
  • endpoint
  • HTTP status
  • traceId
  • request timestamp in UTC
  • rate-limit headers when present

Promotion recommendations

  1. Validate schema handling in sandbox.
  2. Validate business decision mapping on realistic payloads.
  3. Confirm logging, retry behavior, and support handoff details before live traffic.
  4. Promote to production behind a feature flag or equivalent control.
  5. Roll out progressively and monitor.

Use Getting Started > Production Checklist as the final go-live gate.