Skutopia Internal API
The purpose of the skutopia API platform is to provide APIs to internal users. Whether that be engineering building troubleshooting tooling, product builders building product extensions and feature gaps, or AI Builders building tooling to unblock themselves.
API Tiers
The internal API gateway allows connection to all API's Skutopia has, whether that is APIs for engineering tooling, back office tooling, internal products, or merchant facing API's.
Each API has a designated tier that informs the quality of the API and the expected guarantees for a consumer. If you see an API that has lower tier gurantees compared to what you need you should work with the tech team around the use case. This can feed into road map planning to do the eeded uplift.
The current tiering definitions are as follows
| Tier | Definition | API Exposure | Messages Exposure | Consumers |
|---|---|---|---|---|
| Public | - Formal versioning e.g. /v1/ with 12 month depreciation windows - Full auth/authz - Well documented - Complete error contracts - Granular well defined rate limits - Open telemetry coverage - SLO’s defined - An outage, data loss or corruption would be a critical incident - An idempotency contract that conforms to…? | api.skutopia.com internal-api-skutopia.com | External webhooks | Merchants Internal business users |
| Business | - Reliable and trusted but no formal SLO defined - Best effort backwards compatibility Some documentation of intended use and edge cases - Reasonable error handling Some rate limits to mitigate blast radius - Basic observability - Suitable for tools the business depend on (e.g. wms lite) - An outage would be a minor incident | internal-api.skutopia.com (e.g. wms lite) | Internal webhooks (e.g. wms lite) | Internal business users |
| Internal | Breaking changes allowed - No SLO - Good enough validation - Best use for internal experiments or one off tooling - Effectively an engineering test bed | internal-api.skutopia.com | No webhooks, shared message store only | Engineers / internal services |