Getting Started

Get your app connected to our authentication service in minutes

1Get Your API Credentials

Contact your system administrator to get your app registered and receive your credentials

You'll need the following credentials to integrate with our authentication service:

App ID

Unique identifier for your application

API Key

Used for server-to-server authentication

API Secret

Keep this secure and never expose it client-side

2Base URL

All API requests should be made to our base endpoint

Bash

https://your-auth-server.com/api

3Authentication Headers

Include these headers in all your API requests

Bash

x-api-key: your-app-api-key
Content-Type: application/json
Authorization: Bearer user-token  # For user-specific operations

4Quick Test

Test your setup by registering a user

Bash

curl -X POST "https://your-auth-server.com/api/auth/register" \
  -H "x-api-key: your-app-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "test@example.com",
    "password": "securepassword123",
    "confirmPassword": "securepassword123",
    "firstName": "Test",
    "lastName": "User",
    "appId": "your-app-id"
  }'

Available User Roles

Understanding the role system and permissions

user

Standard user with basic access (default role)

admin

Administrator with role management privileges

moderator

Moderator role for content management

member

Member role with extended privileges