Build on top of RigXy

What you can do today

• Create parts in your catalog (POST /parts) — documented below.
• More endpoints (assets, issues, work orders) are rolling out — they use the exact same authentication.

1 · Create an API key

API keys are managed by a company admin. Only an admin can create, disable, or delete them.

1. 1
   Sign in to RigXy as a company admin, then open Settings → API Keys.
2. 2
   Click “New key”, give it a name (e.g. “Nightly sync”), and choose its access:

   • Read-write — can create and change data (needed for Create Part).
   • Read-only — can only fetch data (GET requests).
3. 3
   Add a short description of the key’s purpose and expected call frequency, optionally set an expiry, then click “Submit for review”.
4. 4
   Copy the key immediately — it is shown only once. It looks like rigxy_sk_… Store it somewhere safe; RigXy keeps only a hash and can never show it again.
5. 5
   Wait for approval. A new key is reviewed by an administrator before it works — you’ll see its status change to “Approved”. Editing a key sends it back for review.

2 · Authenticate your requests

Send your key in the X-Api-Key header on every request. Do not put it in a URL, and never commit it to source control.

X-Api-Key: rigxy_sk_your_key_here

The request acts as the admin who owns the key, in that admin’s company. A read-only key may only make GET requests.

3 · API reference: Create a Part