Backend API for managing links and clicks in my system.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
This backend API is built with PHP and the Slim framework. It manages link collections, tracks click events, and supports API key authentication for secure access.
- Slim Framework
- Docker
- MySQL
Ensure you have the following installed:
- PHP 8.3 or higher
- Docker
- PHP Redis extension 8.3 or higher
-
Clone the repository:
git clone https://github.com/luka-lta/luka-lta-api.git cd luka-lta-api -
Install dependencies using Composer:
composer install
-
Start the application using Docker:
docker-compose up -d
-
Run database migrations:
php artisan migrate
Use tools like Postman or cURL to test the endpoints.
POST /auth– Authenticate user and retrieve an access token
POST /key/create– Generate a new API key (requires authentication)
GET /linkCollection/links– Get all available links (requires authentication)POST /linkCollection/create– Create a new link (requires authentication)PUT /linkCollection/{linkId}– Edit an existing link (requires authentication)DELETE /linkCollection/{linkId}– Disable an existing link (requires authentication)
GET /click/track– Track a click eventGET /click/all– Get all click events (requires authentication)
POST /user/create– Create a new userPOST /user/{userId}– Update an existing user (requires authentication)
See the open issues for a list of proposed features and known issues.
Contributions are what make the open-source community amazing! Any contributions you make are greatly appreciated.
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
Distributed under the MIT License. See LICENSE.txt for more information.
luka-lta – info@luka-lta.dev
Project Link: https://github.com/luka-lta/luka-lta-api