Shipwreck API

Frequently
Asked
Questions

Find answers to common questions about integrating and using the Shipwreck API platform. We're always here to help if your question isn't covered below.

Need More Help? View Complete Integration Docs

Authentication & Authorization

How do I obtain an API key?

Log in to your Shipwreck account dashboard and navigate to the API Management section. Click "Generate New API Key" and assign the appropriate permissions for your use case.

How are JWT tokens handled in your API?

Upon successful authentication, we issue JWTs with 1-hour expiration. Refresh tokens are provided for automatic session renewal when required. All tokens use HS256 algorithm with secure random key generation.

Monitoring & Metrics

Can I integrate with my own monitoring tools?

Absolutely! We support Prometheus format metrics endpoints and provide Webhook events for alerting integration with any third-party monitoring system you use.

How granular is the metrics collection?

Metrics are collected at 15-second intervals with full endpoint-level tracking of:

  • Request rate and latency
  • Error rate tracking
  • System resource usage
  • Authentication success/failure rates

Development & Integration

Does the API sandbox have rate limits?

Yes, the sandbox is limited to 100 requests/minute to ensure fair usage. Production environments have configurable limits based on your plan.

How can I test my integration before production?

Our staging environment mirrors production exactly. You'll receive a separate API endpoint that's isolated from real user data. Access it via the same auth system.