AuthNexa API

The AuthNexa API enables authentication and authorization using JSON Web Tokens (JWT). The entire API is implemented as a NestAPI and consists of the following components:

AuthService

The AuthService is responsible for authenticating users. It generates and validates JWTs to ensure that only authorized users can access specific resources.

UserService

The UserService manages user information and provides functionalities such as user registration, profile management, and updates.

MailService

The MailService handles email communication related to user authentication. This may include the delivery of confirmation emails, password reset links, and similar actions.

Note: All requests to this API must start with "/api/" and are accessible only over the internet. The API is available as a localhost API.

Sample Application

Sample: AuthNexa

To use the AuthNexa API in an application, you can send HTTP requests to the appropriate endpoints to authenticate users, manage user information, and trigger email-related actions.

.env creation

Create a file with the name .env and fill this information in there.

Note: Check if the file is in the right directory like ~/api/.env!

# JWT configuration
JWT_SECRET="<YOUR_SECRET>"
JWT_EXPIRATION_TIME="<YOUR_EXPIRATION_TIME>"

# MongoDB connection string (for mongoose)
MONGO_URI="<YOUR_MONGODB_CONNECTION>"

# mail
MAIL_HOST=<YOUR_MAIL_HOST>
MAIL_USER=<YOUR_MAIL_USER>
MAIL_PASSWORD=<YOUR_MAIL_PASSWORD>
MAIL_FROM=<YOUR_MAIL_FROM>

MAIL_TRANSPORT=smtp://${MAIL_USER}:${MAIL_PASSWORD}@${MAIL_HOST}

Installation

Note: You need to have docker installed on your pc!

Run the application in Linux

$ sudo docker-compose up

Run the application in Windows

docker-compose up

Sample Requests:

# Sample: User authentification
curl -X POST http://localhost:4000/api/auth/login -d '{"username": "OldUser", "password": "Password01243"}'

# Sample: User registration
curl -X POST http://localhost:4000/api/auth/register -d '{"username": "NewUser", "password": "Password123", "email": "newuser@example.com"}'

# Sample: Users list requesting
curl -X GET http://localhost:4000/api/users

# Sample: E-Mail for Password reseting send
curl -X POST http://localhost:4000/api/mail/pw-forgot-send/:token -d '{"username": "OldUser", "password": "Password01243", email:"olduser@example.com"}'

Stay in touch

Contact me under my mail

License

Nest is MIT licensed.