Installation & Setup
Install and configure the Neuctra Authix SDK. You must provide appName, baseUrl, apiKey, and appId.
Install SDK
1npm install @neuctra/authixEnvironment Variables
Store credentials securely in environment variables. Never hardcode API keys.
Bash
1# .env — server only; never commit this file
2AUTHIX_API_KEY=ak_live_xxxxxxxx_xxxxxxxxxxxxxxxx
3AUTHIX_APP_ID=your_app_id_hereInitialize SDK
Create a single reusable instance for your application.
Typescript
1// authix.server.ts — trusted server code
2import "server-only";
3import { NeuctraAuthix } from "@neuctra/authix";
4
5export const authix = new NeuctraAuthix({
6 appName: "MyApp",
7 baseUrl: "https://server.authix.neuctra.com/api",
8 apiKey: process.env.AUTHIX_API_KEY!,
9 appId: process.env.AUTHIX_APP_ID!,
10});Next.js Setup
Keep this client in server components, route handlers, or server actions. Never import it into browser code.
Typescript
1// lib/authix.server.ts
2import "server-only";
3import { NeuctraAuthix } from "@neuctra/authix";
4
5export const authixAdmin = new NeuctraAuthix({
6 baseUrl: process.env.NEXT_PUBLIC_AUTHIX_BASE_URL!,
7
8 apiKey: process.env.AUTHIX_API_KEY!,
9 appId: process.env.AUTHIX_APP_ID!,
10});Quick Start
Typescript
1export const signup = (name, email, password) =>
2 authix.signupUser({ name, email, password });
3
4export const login = (email, password) =>
5 authix.loginUser({ email, password });
6
7export const checkSession = () =>
8 authix.checkUserSession();Error Handling
SDK errors include message and optional status.
Typescript
1try {
2 await authix.loginUser({ email, password });
3} catch (err) {
4 console.error(err?.message, err?.status);
5}Production Notes
- Auth routes use HTTP-only cookies (ensure proper CORS setup).
- Every API key grants full account authority and belongs only on a trusted server.
- Frontend code should call your backend, which verifies the user and limits exposed operations.
- Validate inputs before calling SDK methods.
Next Steps
- Authentication: signupUser, loginUser
- Sessions: checkUserSession
- User APIs: getUser, updateUser
- Data APIs: addUserData, addAppData