EsusuApp API Documentation

------------------ USER REGISTRATION--------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/register
METHOD : POST

User registration data format
{ "FirstName" : "Samson", "LastName" : "Olawoyin", "Username" : "olawoyin.samson", "Email" : "[email protected]", "Phone" : "08035561859", "Password" : "123" }

----------------- LOGIN ---------------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/login
METHOD : POST

User login expected data
{ "Username" : "olawoyin.samson", "Password" : "123" }

----------------- LOGOUT ---------------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/logout
METHOD : GET
Description : To logout current user

------------------ CREATE NEW GROUP ----------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/createGroup
METHOD : POST
DESCRIPTION : Group Types are [public , private]

new group expected data
{ "Name" : "Group1", "Description" : "The first contribution group", "PeriodicAmount" : 10000, "Capacity" : 10, "GroupType" : "private" }

------------------ CONTRIBUTE MONEY HAS A GROUP MEMBER--------------------

ENDPOINT: https://esusuapp-api.herokuapp.com/contribute
METHOD : POST
DESCRIPTION : User must be login first before they can do their contribution
DATA:
{ "amount" : 10000, "cycle" : 1, "group" : "Group name here" }

----------------- Search for public group ---------------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/getPublicGroup
METHOD : GET
Successful data return for public group search
{
"Status": "Complete", "Code": 0, "msg": "Transaction successful", "data": [ "Group2", "Group3", "Group4", "Group 5" ] }

The data attribute holds the result of the public group

------------------------ JOIN A GROUP -----------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/joingroup/:GroupName
METHOD : GET
DATA : URL Variable Group name
Description :

GroupName in the URL is should a group name that the user want to join

------------------------ GET A GROUP MEMBERS -----------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/getGroupMember/:Name
METHOD : GET
URL Varaible : Name
Description :

This endpoint required that you pass in a url variable Name which stand for the name of the group that the user created

---------------------- SEND MAIL NOTIFICATION ------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/send_groupinvitation
METHOD : POST
DATA REQUIRED
{ "email" : "[email protected]", "group" : "Group2" }

SUCCESS MSG
{ "Status" : "Complete", "Code" : 00, "msg" : "Group invitation successfully sent", "data" : "fhhf85885855955050505" }

NB : The return data content is to be used to join the group followed by the user username, see the below endpoint on the completetion.

---------------------- JOIN A GROUP VIA INVITATION LINK ------------------

ENDPOINT : https://esusuapp-api.herokuapp.com/joinagroup/:id/:username
METHOD : GET
DATA REQUIRED
URL Variable ID and USERNAME. ID is the data return from Send mail notification endpoint.