Skip to main content

Access and Prerequisites

Before you write code, confirm your workspace is ready to build against.

What you need to start​

At minimum, your team needs:

  • access to your SpotDraft workspace
  • access to Settings -> Developer settings for credential generation and webhook configuration
  • clarity on which environment you are integrating with first: QA or production
  • a secure secret-management location for client-id and client-secret
  • an agreed external identifier strategy for contracts, counterparties, or upstream business records

Environment expectations​

Treat environments as separate systems. Configuration, credentials, contracts, and webhooks should be validated independently.

Use environment-specific planning for:

  • early integration validation in a QA environment
  • staged validation before production rollout
  • production rollout and operational logging

API plans and access scope​

API access is a workspace capability, not just a developer preference. Make sure you confirm:

  • your workspace has public API access enabled
  • your use case is supported by the current public APIs
  • any setup required in the SpotDraft app for workflows, templates, or metadata exists in the environment you're building against

If the use case is already covered by an existing SpotDraft integration, prefer evaluating that path first:

First technical milestones​

See the Quickstart for the exact steps from zero to your first successful request.

Public developer assets​

Before building, make sure your team knows where the public technical assets live: