Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Apix

Apix is a lightweight API solution for integrating user authentication and management into your website or web application. With easy-to-use endpoints for login, signup, and user listing, along with pre-built examples and a demo playground, Apix helps you quickly implement essential API functionality.

Visit the homepage:
Apix Homepage


Features

  • User Management: Retrieve a list of users with a single API call.
  • Prebuilt Examples: Easily copy and paste the example code into your website.
  • Demo Playground: Interactive page to test API requests and see live results.

API Endpoints

1. Signup

URL: http://apix.rf.gd/api.php?mode=signup&username=[username]&password=[password]

  • Parameters:

    • username (string) - Desired username.
    • password (string) - Desired password (will be hashed).
  • Response:

    • On success:
      { "status": "success", "message": "User created successfully" }
    • On failure:
      { "status": "error", "message": "Username already exists" }

2. Login

URL: http://apix.rf.gd/api.php?mode=login&username=[username]&password=[password]

  • Parameters:

    • username (string) - The username to log in.
    • password (string) - The password entered during login.
  • Response:

    • On success:
      { "status": "success", "message": "Login successful", "username": "demoUser" }
    • On failure:
      { "status": "error", "message": "Invalid username or password" }

3. List Users

URL: http://apix.rf.gd/api.php?mode=get_users

  • Response:
    • On success:
      { "status": "success", "users": [{"username": "user1"}, {"username": "user2"}] }
    • On failure:
      { "status": "error", "message": "Error fetching users" }

4. Get Username From UUID

URL: http://apix.rf.gd/api.php?mode=uuid&uuid=[uuid]

  • Response:
    • On success:
      {"status":"success","username":"demoUser"}
    • On failure:
      {"status":"error","message":"UUID not found"}

Demo Playground

Check out the interactive demo where you can test the login, signup, and list users functionality. It's a great way to see how the API works before integrating it into your project.

Visit the demo page:
Demo Playground


Prebuilt Examples

Apix comes with prebuilt frontend examples for quick integration into your website. You can preview and copy the code to use in your projects.

Available Examples

  • Example 1: Bootstrap login form

Visit the examples page:
Examples


Contributing

We welcome contributions! Feel free to fork this repository, create a branch, and submit a pull request. Please ensure that your code follows the coding style and includes tests where applicable.


License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Free Opensource login/signup API

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages