Authentication API
Login
This endpoint is used to authenticate a user and retrieve an access token.
URL: https://apis.rmlconnect.net/auth/v1/login/
- Method: POST
- Content-Type: application/json
- Authentication Required: No
Request Headers
| Key | Value |
|---|---|
| Content-Type | application/json |
| Cookie | csrftoken=<your-csrf-token> (Optional, if CSRF protection is enabled) |
Request Parameters
| Field | Type | Description |
|---|---|---|
| username | string | Your RML Connect username |
| password | string | Your RML Connect password |
Request Body
{
"username": "XXXXXX",
"password": "XXXXXX"
}Response
Success (201 OK)
Returns authentication details (typically includes a token or session info).
Response-2
Invalid credentials or missing parameters.
{
"status": "invalid credentials or the account has been deactivated"
}Error Responses
| HTTP Status | Description | Example |
|---|---|---|
| 400 Bad Request | Malformed request body or missing parameters | {"detail": "Invalid JSON."} |
| 401 Unauthorized | Invalid credentials or missing token | {"detail": "Invalid username or password"} |
| 403 Forbidden | Token is invalid or expired | {"detail": "Authentication credentials were not provided."} |
| 500 Internal Server Error | Server-side error | {"detail": "An unexpected error occurred."} |
Session & Token Handling
- Tokens are usually time-bound (1Hour). Ensure you handle token expiration by refreshing or prompting re-login.
- Store tokens securely; avoid exposing them in URLs or client-side code.
Updated 11 days ago
Did this page help you?