Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/JanContrerasDev/gestor-contrasenas/llms.txt

Use this file to discover all available pages before exploring further.

Secure Password Management API

A Laravel-based REST API for managing passwords securely. Build password management features into your applications with simple CRUD operations and robust validation.

Quick Start

Get your password management API up and running in minutes

1

Clone and Install

Clone the repository and install dependencies:
git clone https://github.com/JanContrerasDev/gestor-contrasenas.git
cd gestor-contrasenas
composer install
2

Configure Environment

Copy the example environment file and configure your database:
cp .env.example .env
php artisan key:generate
Update your .env file with database credentials.
3

Run Migrations

Set up the database schema:
php artisan migrate
4

Make Your First API Call

Start the development server and test the API:
php artisan serve
Create a password entry:
curl -X POST http://localhost:8000/api/createPassword \
  -H "Content-Type: application/json" \
  -d '{
    "password": "mySecurePass123",
    "sistema": "Production DB",
    "usuario": "admin"
  }'

Explore the API

Comprehensive endpoints for password management

List Passwords

Retrieve all active password entries in your system

Get Password

Fetch a specific password entry by ID

Create Password

Add new password entries with validation

Update Password

Modify existing password entries

Delete Password

Soft delete password entries from the system

Error Handling

Understand API error responses and status codes

Key Features

Built with modern Laravel best practices

RESTful Design

Clean, predictable API endpoints following REST conventions for easy integration

Laravel Sanctum

Built-in authentication support with Laravel Sanctum for secure API access

Input Validation

Comprehensive validation rules ensure data integrity and security

Ready to get started?

Follow our quickstart guide to set up your password management API in minutes, or dive into the full API reference to explore all available endpoints.

Build docs developers (and LLMs) love