Skip to main content

Authentication

Overview​

To interact with the OneUp API, you’ll need to authenticate using your personal API key. This key identifies your account and must be included in every API request.

Step 1: Generate Your API Key​

  1. Go to https://www.oneupapp.io/api-access.
  2. Log in to your OneUp account.
  3. Click Generate API Key.
  4. Copy your generated API key — you’ll use it in your API requests.

Step 2: Use Your API Key in Requests​

Include your API key as a query parameter named apiKey in all your API calls.

Example Request:

GET https://www.oneupapp.io/api/listcategory?apiKey=YOUR_API_KEY

Example Response:

{
  "message": "OK",
  "error": false,
  "data": [
    {
      "id": 49839,
      "category_name": "AAA testingg",
      "isPaused": 0,
      "created_at": "2020-12-09 14:37:45"
    }
  ]
}

✅ Result: The API authenticates your key and returns data linked to your account.

Security Best Practices​

Here are some important tips for keeping your API key secure:

  • 🔒 Keep it private — Never share your API key publicly or commit it to version control systems like GitHub.
  • 🧩 Use environment variables — Store your API key in environment files (e.g., .env) instead of hardcoding it into your codebase.
  • 🕒 Regenerate if exposed — If you suspect your API key was compromised, immediately revoke and regenerate it from your API Access page.
  • 🚫 Limit access — Only give your API key to systems or services that require access to OneUp.

By following these steps, you ensure that your OneUp API integration remains both functional and secure.