API Documentation

Issue a Bearer JWT for machine-to-machine API access. Route mapping: 'POST /api/v1/access/token': 'AuthController.getToken'.

Headers

Payload

Example request

POST /api/v1/access/token
Content-Type: application/json

{
  "user_name": "api.user",
  "client_id": "your-client-id",
  "client_secret": "your-client-secret",
  "security_token": "your-security-token",
  "access_id": "plant-001",
  "access_type": "quickgrind-netsuite",
  "instance": "prod",
  "expiry": 3600
}

Success response

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer"
}

Error responses

Verify a Bearer JWT. Returns the token payload when valid, or an error when invalid/expired. Also available as GET /api/v1/access/tokenValid.

How to send the token

Example request

POST /api/v1/access/tokenValid
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

Success response

{
  "valid": true,
  "id": 12,
  "access_type": "quickgrind-netsuite",
  "access_id": "plant-001",
  "instance": "prod",
  "expiresIn": 3600,
  "iat": 1710000000,
  "exp": 1710003600
}

Error responses

Sign in with email/password and create a browser session cookie.

Payload

Example request

{
  "email_address": "admin@example.com",
  "password": "your-password",
  "rememberMe": true
}

Create a new user account and sign the requester in.

Payload

Send a password recovery email when Mailgun is configured.

Payload

Set a new password using a recovery token, then log in.

Payload

Clear the current browser session. Also available via /logout.

Payload

None

Update password for the currently logged-in user.

Payload

Update profile fields for the logged-in user.

Payload

Update billing card details when Stripe is configured.

Payload

Returns the decoded token payload for the authorized caller. Route mapping: 'GET /api/v1/users': 'UserController.getUsers'.

Headers

Payload

None

Example response

{
  "id": 1,
  "access_type": "quickgrind-netsuite",
  "access_id": "plant-001",
  "iat": 1710000000,
  "exp": 1710003600
}

Create a user from the admin UI.

Payload

{
  "inputs": {
    "first_name": "Jane",
    "middle_name": "",
    "last_name": "Doe",
    "user_name": "jane.doe",
    "email_address": "jane@example.com",
    "password": "hashed-or-plain-as-configured",
    "client_id": "client-id",
    "client_secret": "client-secret",
    "vmcs-register": true
  }
}

Update user profile fields from admin.

Payload

{
  "id": 12,
  "inputs": {
    "first_name": "Jane",
    "last_name": "Doe",
    "email_address": "jane@example.com",
    "user_name": "jane.doe"
  }
}

Update a user’s password from admin.

Payload

{
  "id": 12,
  "inputs": {
    "password": "new-password"
  }
}

Replace a user’s access types.

Payload

{
  "id": 12,
  "inputs": {
    "vmcs-register": "true",
    "quickgrind-netsuite": "true"
  }
}

Generate and save a new security token for a user.

Payload

{
  "id": 12
}

Deliver the public contact form message (email features depend on Mailgun config).

Health check endpoint.

Example response

{
  "success": true
}