Authentication
Send your channel key on every request:
| Header | Meaning |
|---|---|
x-api-key | Your channel key, issued per channel. Treat it as a secret. |
The key is the only credential. Do not send an organization header: a request that carries x-mealco-org-id is rejected with 401.
Scope
A channel key belongs to your channel, not to a restaurant. It reaches the stores that sell through your channel, whichever restaurant operates them, and nothing else. A store that is not on your channel answers 404, the same as a store that does not exist.
A channel key works only on the Ordering API.
Handling keys
- Keep the key on your servers. Anyone who holds it can act as your channel.
- Treat the whole key as a secret. The leading
otk_…part, up to the second_, identifies the key. Quote that part, never the whole key, in a support request. - To rotate a key, ask for a new one, move your traffic to it, then have the old one retired. Both keys work during the overlap.
- If a key is exposed, tell us immediately at support@yoursouschef.com so that it can be revoked.
Rate limits
The limit is per key: 300 requests a minute for each channel key across /ordering/*. If you need a higher limit, write to support@yoursouschef.com with the rate you need.
Any operation may answer 429. Honour Retry-After when it is present. When it is not, wait 60 seconds and add jitter. See Errors and retries.
Authentication errors
401: the key is missing, unknown or revoked, or the request sentx-mealco-org-id.429: the key is over its rate limit.