Onboarding

How it works

Getting access is a manual, email-based process today — there's no self-serve signup form.

1. Email the API team. Send a request to apionboarding@samtec.com. Include which API(s) you plan to use (Catalog, Lead Time, Pricing, Orders, Quotes, Models, Stats, or Webhooks) and a short description of your use case.
2. Receive your token. The team provisions a JWT (JSON Web Token) and emails it back to you. This is the only credential you need — there's no separate client ID or secret.
3. Start making requests. Add the token as a Bearer token on the Authorization header of every request, along with a client-app-name header. See Authentication for header details and code examples in cURL, JavaScript, and C#.

What the token grants

The token is a JWT that Samtec issues with claims scoped to the APIs you were approved for. It does not expire — for current purposes it behaves like a long-lived API key rather than a short-lived session token. There's no refresh flow to implement.

If you need access to an additional API later, email apionboarding@samtec.com again — the team will update your token's claims rather than issue a new one.

The client-app-name header

Every authenticated request also requires a client-app-name header — a string identifying the calling application. This isn't a secret and doesn't need pre-approval from Samtec, but it must be 3–100 characters, and every request that omits it fails with a 400.

Pick a value that identifies the specific system making the call, for example part-detail-page or order-sync-service. If you have multiple distinct integrations calling Samtec's APIs, use a different value for each one — Samtec uses this header to attribute API usage per calling application, and distinct values make that attribution meaningful. If you're only building one integration, a single consistent value is fine.

Rate limits

All APIs are limited to 1,000 requests per second. Requests beyond that return 429 Too Many Requests. This applies across your token, not per endpoint.

Where to find request and response details

Every field in a request or response — including data types, which fields are required, and example values — is documented on that API's Reference page under APIs → <API> → Reference in the sidebar. Each endpoint there has an interactive playground where you can try a real call using the token from this page.

Next step

Once you have a token, head to Authentication to see how to use it in the portal playground and in your own code.