The API powering...

My Subscription

The subscription management app: https://bpdm88.github.io/subscriptions-app/.

My Subscription lets you view, arrange and manage your subscriptions (e.g. gym membership, entertainment, and news services). Each card contains key information about the subscription, including the monthly cost, spend so far, days remaining to cancel, and categories that the subscription belongs to. The traffic light indicator reflects how much time is left until a payment is due. The user can add, edit and delete subscriptions, as well as being able to sort subscriptions by their cancellation date, and by category.
Built by Tumeka Burston, Benjamin Main, Jacques Coetzee and Sophie Stammers.

Restful API: Subscription Tracker

This is the API for the Subscription Tracker App.

Version 1.1.1

This API is based on a MVP version of the app. The app is currently a single use instance where a user can view their subscriptions, be able to request full details of their subscriptions, add a new subscription, edit and delete an existing subscription.

• Restful API: Subscription Tracker
• Subscriptions
  • GET all subscriptions
  • POST a new subscription
  • PUT an existing subscription in full
  • PATCH parts of an existing subscription
  • DELETE a subscription

Version 1.2

Users are able to filter their subscriptions

This will use these requests

• Categories
• GET all categories
• GET a specific subscription that is grouped with the same category

Subscriptions

GET all subscriptions

To get all the subscriptions available, use:

GET /api/subscriptions

POST a subscription

POST /api/subscriptions
Request
• subscription_name
• cost
• start
• payment_date
• notice_period

GET a subscription with given id

DELETE /api/subscriptions/id

"EDIT" a subscription

PUT /api/subscriptions/id

This will update an entire subscription

Request

• subscription_name
• cost
• start
• payment_date
• notice_period

"EDIT" part of a subscription

PATCH /api/subscriptions/id

This will update an entire subscription

Request

• subscription_name
• cost
• start
• payment_date
• notice_period

DELETE a subscriptions

DELETE /api/subscriptions/id


Version 1.2

In this instance of the app we would like to allow the user to filter through their subscriptions using a Categories table via Laravel that is already created with it's end-points.




Version 2.0

In this instance of the app we would like to create API end points to co-inside with the front-end where a user is able to input their subscription details with a POST request, be stored and allow the user to view with a GET request that is already set up.




Version 3.0

In this instance of the app we would like to have multiple users, make use of passports and authentication in Laravel, create a log-in system and be able to add a notification feature that gets sent to the user's email address




Documents written by Tumeka (TumekaB) and Sophie (ammersive).