Skip to content

Production checklist

Before deploying an integration:

  • Configure BaseUrl from environment or deployment configuration. Never fall back to the documentation host.
  • Store the API key in a secret manager and give it minimum scopes.
  • Set a request timeout suitable for the workload.
  • Keep automatic write retries disabled unless the workflow has reconciliation.
  • Handle 401, 403, 404, 422, 429, and transient 5xx failures explicitly.
  • Use async pagination for large ticket/document sets.
  • Propagate cancellation from jobs and HTTP requests.
  • Add correlation IDs and redact Authorization from logs.
  • Record created Okatana IDs immediately after successful writes.
  • Use stable client markers for external-system synchronization.
  • Verify WIP and relationship behavior in a staging deployment.
  • Pin CI to the repository's OpenAPI contract and run coverage checks after API changes.

For long-running ASP.NET Core services, prefer the provided AddOkatanaClient typed-client integration. For standalone jobs, either reuse one OkatanaClient instance for the job lifetime or inject a managed HttpClient.