Create a NEXUS API credential

Summary

Create scoped API credentials so an outside system can call the NEXUS API. Each credential has a label, an environment, and a set of scopes that limit what it can do.

Before you start

• Required role: Admin or Developer
• Decide which environment and the minimum scopes the integration needs

Steps

1. Go to Integrations ? NEXUS API ? API Keys (/nexus_api_keys.cfm).
2. Click New Credential.
3. Enter a Label and choose the Environment. _(Fields: "Label *", "Environment")_
4. Select Scopes (least privilege): Catalog — Read; Orders — Read; Orders — Write; Invoices — Read; Reports — Read; Suppliers — Read; Account — Read. _(Field: "Scopes *")_
5. Click Generate Credential.
6. Copy the secret now — it is shown once.

What success looks like

The credential appears in Your API Credentials with its Client ID, environment, scopes, last-used, and status.

Gotchas / troubleshooting

• Grant only the scopes the integration needs; "Orders — Write" lets the client submit/confirm POs.
• The secret is shown once at generation; if lost, rotate by creating a new credential.

Related

• Test requests in the API Playground
• View API usage
• Create a webhook endpoint