Skip to content

README.md

Latest commit

 

History

History
111 lines (95 loc) · 2.65 KB

README.md

File metadata and controls

111 lines (95 loc) · 2.65 KB

BetterX API Documentation

Base URL

https://tpm28.com/betterx/

Endpoints

1. Check if user exists

curl -X GET "https://tpm28.com/betterx/users/johndoe"

Response:

{
    "exists": true
}

2. Create new user

curl -X POST "https://tpm28.com/betterx/users" -H "Content-Type: application/json" -d "{\"username\": \"johndoe\", \"token\": \"abc123\"}"

Response (201 Created):

{
    "id": 1,
    "username": "johndoe",
    "token": "abc123",
    "status": 1,
    "appVersion": null,
    "usedMoreThanHour": false,
    "country": null
}

3. Get user status

curl -X GET "https://tpm28.com/betterx/users/johndoe/status"

Response:

{
    "status": 1
}

4. Update status (Authentication required)

curl -X PUT "https://tpm28.com/betterx/users/johndoe/status?token=abc123" -H "Content-Type: application/json" -d "{\"status\": 0}"

5. Update app version and usage (Authentication required)

curl -X PUT "https://tpm28.com/betterx/users/johndoe/app-update?token=abc123" -H "Content-Type: application/json" -d "{\"version\": \"1.0.0\", \"usedMoreThanHour\": true}"

6. Save installation country (Authentication required)

curl -X PUT "https://tpm28.com/betterx/users/johndoe/location?token=abc123" -H "Content-Type: application/json" -d "{\"country\": \"France\"}"

7. Heartbeat (Authentication required)

curl -X POST "https://tpm28.com/betterx/users/johndoe/heartbeat?token=abc123"

The heartbeat must be sent every minute. If no heartbeat is received for more than one minute, the user's status will automatically change to "Inactive" (1).

8. Twitter Authentication

Get Twitter Authentication URL

curl -X GET "https://tpm28.com/betterx/connect-request"

Response:

{
    "auth_url": "https://api.twitter.com/oauth/authorize?oauth_token=...",
    "token": "<oauth_token>"
}

Get Access Token

After user authorization, use the oauth_token and oauth_verifier to get the access token:

curl -X GET "https://tpm28.com/betterx/get-token?oauth_token=YOUR_TOKEN&oauth_verifier=YOUR_VERIFIER"

Response:

{
    "oauth_token": "...",
    "oauth_token_secret": "...",
    "user_id": "...",
    "screen_name": "..."
}

Status Codes

  • 200 OK: Request successful
  • 201 Created: User created successfully
  • 400 Bad Request: Error in request (e.g., user already exists)
  • 401 Unauthorized: Invalid or missing token
  • 404 Not Found: User not found

UserStatus Model

  • 0: Active
  • 1: Inactive
  • 2: DoNotDisturb