Developer CenterGuidesTest vs Live Keys

    Test vs Live Keys

    Test and live traffic share the same host, while API keys and stored records carry the `environment` that determines behavior.

    What Exists Today

    • API keys are created with environment = live | test.
    • Public `/api/v1` ingest routes authenticate those keys and store the key environment on created records.
    • /api/metro2-records/generate-file accepts an environment body field and supports API-key auth.
    • Superadmin SFTP transfer logic simulates success for test-environment transmissions.

    What Still Uses the Shared Host

    • No separate public sandbox hostname is implemented.
    • Public webhook test delivery is available under /api/v1/webhooks/{id}/test.
    • No public simulated SFTP host is documented or exposed for third-party use.
    • Public scheduling uses the same host under /api/v1/schedules.

    Recommended Usage

    1. Use the same host, https://metro2.switchlabs.dev, for both live and test traffic.
    2. Create a test key from the dashboard when validating your integration.
    3. Submit data to the real `/api/v1` routes with the test key.
    4. When you are ready for live traffic, create or switch to a live key instead of changing hosts.