← Docs

Quickstart

From zero to your first API call in 5 steps, with no one to approve. Every call goes through the gateway https://api.nextx.vn.

Only pushing leads into the CRM of one workspace?

No app needed — an admin creates an API key in the NextX app and you send the X-Api-Key header. See the path for NextX customers.

API key → Push leads into CRM →
1

Partner account

Sign up ⇒ you get a Developer workspace with sample data that never expires. Already have a NextX account: create an extra Developer workspace.

2

Create an app

My apps → Create app → pick Use cases → get the App ID + App Secret right away (Development mode). The App Secret is shown only once — keep it in a secret store.

Open My apps →
3

Install the app in your Developer workspace

In the app: Installed workspaces → Install in your workspace. Development mode installs in up to 3 of your own workspaces; after Publish any customer can install. Not installed ⇒ the token call fails with 403 oauth2.app_not_installed.

4

Get an Access token

curl -X POST https://api.nextx.vn/api/v1/iam/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=<APP_ID>" \
  -d "client_secret=<APP_SECRET>" \
  -d "workspace_id=<WORKSPACE_ID>"
# → { "access_token": "...", "expires_in": 3600, ... }

Or press Generate Access Token in the Test Console. Access tokens live 1 hour; call this step again when one expires.

5

Your first API call

curl "https://api.nextx.vn/api/v1/crm/contacts?pageSize=5" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"

Missing scope → 403; over the Rate limit → 429. See the error code table.

Test Console

Every app has a Test Console: pick an installed workspace, Generate Access Token, call endpoints with the embedded API Explorer and read the API Logs. A Developer workspace cannot send anything out (customer messages, SMS/ZNS/email, e-invoices, payments, calls), so test freely.

Publish

Press Publish: the Publish checklist runs automatically — logo + description, a support email that receives mail, a reachable homepage + privacy policy, a public https Redirect URI, grantable scopes, enough successful API calls across several endpoints, an error rate under 30%, a verified owner email. All green ⇒ Live and any customer can install it with the install link. No manual review; enough customer reports suspend the app automatically.

Next