Test mode and API keys

Updated 2026-09-07

Test mode keeps integration work off production carriers and live Stripe charges. Stay in test until create-order → rates → buy → void is green.

How to stay in test

• Create and use keys that start with nm_test_
• In MCP OAuth consent, choose Test (default)
• Point webhooks at a staging HTTPS URL while validating payloads
• Prefer Idempotency-Key on creates so retries are safe

What differs in test

• Carrier rating / purchase uses test pathways for your environment
• Mistakes should not consume live postage (still void test labels when created)
• Webhook deliveries still need a reachable HTTPS endpoint

Promote to live checklist

1. Finish the quickstart scripts on test keys.
2. Attach a Billing payment method for platform postage.
3. Create nm_live_ keys and store them in a secrets manager.
4. Re-register webhooks for production URLs.
5. Buy one cheap live label, void if unused, then cut over traffic.
6. Revoke unused test keys if they leave staging.

MCP note

Call nm_me and confirm key_environment is test before nm_buy_label. See MCP.