‹ Prev | Next ›

API Features

The Starter API is a fully featured REST API that comes with many standard features out of the box for front end consumption.

The only currently available version of the Starter API is built on Laravel 12.

REST Based

The API aims to follow a standard REST format with route paths, methods and naming conventions following a consistent pattern.

Login / Register

The standard login and register end points are included and can be easily updated for specific needs and setups.

Account Activation

Account activation has been setup with a few config options to control user activation. One flag is used to auto enable/disable activation all together. Then a secondary flag is used to set a grace period in hours starting from 0 which allows use of the app for a time without activation.

Passowrd Reset

The standard password reset email with a link to the update page is also included out of the box.

Billing & Subscriptions

The API includes separate endpoints for updating and deleting a users's billing method. Some basic subscriptions logic is also included for creating, stopping and updating user subscriptions which can be done both as a user and admin. This will integrate directly with the underlying library such as Cashier in Laravel.

Roles & Permissions

As the API is general purpose and controls access to all the data in the app there will of course be different access levels to diffferent endopints. Each endpoint has it's own permissions check to determine access which can easily be controlled as need be.

Databse Backups

Backups are setup to run automatically on predefined intervals and also before each deploy.

Image Upload

Some basic file upload wrapper logic is also incldued to make it much easier to deal with image resize and specify subfolders to store fiels in via config files.

Sample CRUD

As the Starter App is made to work with the Starter API some basic sample CRUD code has been included for users, totos and tasks.

API Testing

Testing is critial for standalone API's and a great way to drive development with a TDD approach. The Starter API ships with a full suite of tests which can also be used as a great sample for adding more routes and accompanying test cases.

© Websanova 2025