Authentication
The SignEngine API uses Bearer Token authentication. To access protected endpoints, you must include a valid JWT in the Authorization header.
Base URL: https://api.signengine.com (Production) or http://localhost:7071 (Local)
Security Scheme
All protected endpoints require the following header:
Authorization: Bearer <your_jwt_token>
Tokens are obtained via the /api/Login endpoint.
Account Management
Register
Create a new user account.
Endpoint: POST /api/Register
Request Body:
{
"email": "[email protected]",
"password": "strongPassword123!",
"invitationCode": "INVITE-CODE",
"turnstileToken": "optional-turnstile-response"
}
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | User's email address. |
password | string | Yes | Must be at least 8 characters. |
invitationCode | string | Yes | Valid invitation code required for sign-up. |
turnstileToken | string | No | Cloudflare Turnstile token for captcha verification. |
Response (201 Created):
{
"message": "User registered successfully",
"userId": "12345-abcde-..."
}
Login
Authenticate and retrieve a session token.
Endpoint: POST /api/Login
Request Body:
{
"email": "[email protected]",
"password": "strongPassword123!",
"turnstileToken": "optional-turnstile-response"
}
Response (200 OK):
{
"token": "ey... (JWT Token)",
"user": {
"userId": "12345-abcde-...",
"email": "[email protected]",
"role": "user"
}
}
Errors:
401 Unauthorized: Invalid credentials or invalid captcha.400 Bad Request: Missing parameters.