Get started · 4 of 15
Credentials and onboarding
Onboard your platform, get each seller's marketplace API key and your signing secret in the sandbox and in production, and rotate the secret.
Every platform, whatever its subscription, uses two credentials in the sandbox and in production. It calls Snapcaster with a seller’s marketplace API key, and it verifies Snapcaster’s webhooks with its own signing secret.
| Credential | Scope | In the sandbox | In production |
|---|---|---|---|
A seller’s marketplace API key (mp_{sellerCode}_{hex}) | One seller | In the sandbox 1Password share | Each seller generates its own |
| Your platform’s signing secret (HMAC-SHA256) | Your platform, per environment | In the sandbox 1Password share | In the production 1Password share |
Use a seller’s key
Section titled “Use a seller’s key”Send the seller’s key as a bearer token, Authorization: Bearer mp_{sellerCode}_{hex}, on every request you make for that seller.
The key identifies the seller, so you do not send a separate seller id.
There is no API key shared by all sellers on a platform.
When you receive a seller’s key, validate it with GET /me and store the sellerId and sellerCode it returns with the key.
sellerId is the same number as data.seller_id on every webhook event for that seller, so you can route each event to its seller from the first one.
The same response names your platform’s subscription in subscription: orders, inventory or both.
Check it before you build, because it decides your path and which event moves your stock.
Onboard your platform
Section titled “Onboard your platform”Onboard once in each environment, the sandbox first and production when you go live.
- Email info@snapcaster.gg with the subscription you need, your webhook endpoint URL, and your technical contact’s email address. Choose your path explains the three subscriptions.
- Snapcaster sets up your platform, registers your endpoint, and sends a 1Password share link to your technical contact. The link comes by email or over a channel you already use with Snapcaster, such as Discord.
- Open the link when you are ready to copy its values into your own secret store. It opens only for your technical contact’s email address, and 1Password emails a verification code to that address before it shows the item.
- Copy every value into your secret store, because the share expires after one view or 24 hours.
- Reply to Snapcaster to confirm you received the share, but do not repeat any value.
The sandbox share holds your sandbox signing secret and the sandbox seller’s marketplace API key, login, and authenticator secret. The production share holds only your production signing secret, because each production seller generates its own key.
If the link expired or says it was already viewed, ask Snapcaster for a new one, and Snapcaster rotates the credentials it held first. Snapcaster’s emails and chat messages carry only the link, never a credential value, so never send a signing secret by email either. To change your endpoint later, email info@snapcaster.gg. One subscription for each platform covers changing your subscription.
Get each seller’s production key
Section titled “Get each seller’s production key”Snapcaster provisions no seller in production. Each seller signs up through partner onboarding once Snapcaster admits it for your platform, then generates its own key in its Snapcaster dashboard and gives it to your platform to validate. Set up each seller has each step and who takes it.
Rotate the signing secret
Section titled “Rotate the signing secret”Your platform has one live signing secret in each environment, so a rotation is a cutover at a time you agree with Snapcaster.
- Email info@snapcaster.gg to ask for a new signing secret, and agree on a time for the switch.
- Store the new secret from the 1Password share Snapcaster sends you.
- At the agreed time, Snapcaster replaces the secret and signs every later attempt with the new one, including retries of earlier events. Switch your receiver to the new secret at the same time.
If a delivery fails verification during the switch, return non-2xx, and Snapcaster retries it signed with the new secret.
Sandbox and production setup
Section titled “Sandbox and production setup”The rest of setup lives on other pages.
| To | Read |
|---|---|
| Look up the test SKUs every sandbox seller can list | Test SKUs and sandbox guarantees |
| Raise buyer cancellation and change requests on your test orders | Act as the sandbox buyer |
| Close the sandbox seller’s browse requirements with its login | Finish sandbox seller setup through the account API |
| Ship a sandbox test order on Path A | Ship a Path A test order |
| Set up each seller in production, from admission to its first listings in browse | Set up each seller |
Need help?
The email includes this page and selects sandbox as the environment. Update it if you need help with production.
Never include an API key or signing secret in the message.