Skip to main content

Access and Prerequisites

Before writing code, confirm that the target workspace and operating model are ready for API-based integration work.

What you need to start​

At minimum, your team needs:

  • access to the target SpotDraft workspace
  • access to Settings -> Developer settings for credential generation and webhook configuration
  • clarity on which environment you are integrating with first: UAT 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 UAT 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. Before promising an integration timeline, confirm:

  • the target workspace has public API access enabled
  • the integration use case is compatible with the APIs exposed in the current public schema
  • any product-side setup required for workflows, templates, or metadata is available in the target environment

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

First technical milestones​

The first reliable milestones are:

  1. confirm the correct API base host and versioned public path
  2. generate UAT credentials
  3. make one successful authenticated request
  4. identify the metadata and webhook model for your use case
  5. decide whether a native integration already fits before building custom logic

Do not skip directly to workflow-specific coding before those milestones are stable.

Public developer assets​

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