Docs
IntegrationsGetting Started

Environments

Test vs. production environments — credentials, accreditation, and environment differences.

The Carrot API uses credential-based environment separation with the same base URL.

Environment model

  • API base URL: https://api.carrot.eco
  • Auth URL: https://auth.api.carrot.eco/oauth2/token
  • Environment is selected by the credential pair (clientId / clientSecret), not by host.

Test vs production behavior

  • Test credentials can only operate on test data.
  • Production credentials can only operate on production data.
  • Cross-environment relationships are not allowed.

Credential lifecycle recommendations

  • Store credentials in your secrets manager.
  • Rotate credentials through controlled rollout.
  • Request new bearer tokens before expiry.

Go-live checklist

  1. Validate full flow in test (create, event append, attachment upload, retrieval).
  2. Confirm retry/idempotency behavior with deduplicationId.
  3. Confirm rate limit behavior under expected throughput.
  4. Promote to production credentials.

Related references:

Core Concepts

Integration core concepts — documents, MassID story, immutability, and the event model.

Submitting a MassID

End-to-end guide for submitting a MassID — create document, add events, and close.

On this page

Environment model
Test vs production behavior
Credential lifecycle recommendations
Go-live checklist