Dashboard BN
Contact Us Privacy Policy About Us Terms & Conditions Download APK Facebook Page WhatsApp Channel API Documentation

API Documentation

SiteName.ComThe API allows you to integrate various features and data from our platform into your own applications or systems. This documentation will provide you with all the information you need to use the API.

Please note, you will need an active SiteName.Com account and an API Key to use the API.

1. Getting Started

Base URL:

https://api.sitename.com/v1/

Authentication:

Each request you make to use our API must include a valid API Key. API Key can be generated from your account dashboard.

The API Key should be sent as ``X-API-KEY'' in the request header.

Header:
  X-API-KEY: your_api_key_here

2. Available Endpoints

Our API offers the following endpoints. The required parameters and expected response for each endpoint are given below:

✔ Get User Profile

Retrieve a specific user's profile data.

HTTP Method:GET

Endpoint:/user/{user_id}/profile

Parameters:

  • `user_id` (path): (number) User ID.(required)

Example Request:

GET https://api.sitename.com/v1/user/123/profile
Header:
  X-API-KEY: your_api_key_here

Expected Response (Example Response):

{
  "status": "success",
  "data": {
    "user_id": 123,
    "username": "example_user",
    "email": "user@example.com",
    "balance": 150.75,
    "member_since": "2023-01-15"
  }
}

✔ Get Available Micro-Jobs

Get the list of all micro-jobs currently available.

HTTP Method:GET

Endpoint:/jobs/available

Parameters:

  • `category` (query): (optional) filter by category.
  • `limit` (query): (optional) number of results per page (default: 10).

Example Request:

GETsitename.com/v1/jobs/available?
category=social_media

Expected Response (Example Response):

{
  "status": "success",
  "data": [
    {
      "job_id": 101,
      "title": "YouTube Video Like",
      "reward": 0.05,
      "category": "social_media"
    },
    {
      "job_id": 102,
      "title": "Facebook Page Follow",
      "reward": 0.03,
      "category": "social_media"
    }
  ]
}

3. Error Responses

If the API request fails, you will receive an error response that will explain the nature of the problem:

Example: Invalid API Key

HTTP Status:401 Unauthorized

{
  "status": "error",
  "message": "Invalid API Key"
}

Example: Invalid parameter

HTTP Status:400 Bad Request

{
  "status": "error",
  "message": "Missing or invalid parameter: user_id"
}

4. Rate Limiting

Rate limiting is applied to avoid unwanted load on our API. Typically, 30 requests are allowed per minute. If you exceed the limit you will get `429 Too Many Requests` status code.

5. support

If you have any questions or issues regarding the API, please contact usSupport teamcontact with