Authentication and roles
Sending your key
Section titled “Sending your key”Send the key as the bare value of the Authorization header:
GET /v1/Products?Query=airfryer HTTP/1.1Host: productapiext.reshift.nlAuthorization: YOUR_API_KEYAccept: application/jsonThere is no Bearer prefix. Some HTTP clients refuse an Authorization header without a scheme; in .NET use TryAddWithoutValidation.
Treat the key as a secret. Call the API from your server, never from a browser or mobile app, where anyone can read the key. If a key leaks, ask us for a new one; the old one is then revoked.
One key per market
Section titled “One key per market”Every key belongs to one market (for example Kieskeurig Netherlands or Belgium). The market decides which shops and prices you see, and which shop ids you get. If you need several markets, you get a key per market.
Your key can also be limited to certain categories, or exclude certain shops. That is agreed with you when the key is issued.
Each key has one or more roles. Calling an endpoint without the matching role returns 403 Forbidden.
| Role | Unlocks |
|---|---|
Product |
GET /v1/Products, GET /v1/Products/{id} |
Specifications |
GET /v1/Products/{id}/Specifications, and specifications in the product details |
Price |
GET /v1/Products/{id}/Prices, GET /v1/Shops/{shopId}/Offers |
History |
GET /v1/Products/{id}/History |
Category |
GET /v1/CategoryTreeNodes, GET /v1/Categories |
MerchantFeed |
GET /v1/Shops/{shopId}/merchant |
| none | GET /v1/Shops works with any valid key |
Need a role you don’t have? Ask your contact person. Roles are changed without any change on your side.
Status codes for authentication
Section titled “Status codes for authentication”| Status | Meaning |
|---|---|
401 Unauthorized |
No key, or a key we don’t know. The response has a WWW-Authenticate header. |
403 Forbidden |
The key is valid but lacks the role for this endpoint. |
400 Bad Request on AffiliateId |
The affiliate id is not registered on your key. See Affiliate ids. |