Send-It-API

Sendify API is an appliaction that allows users to create parcels and track the parcels from pick up to destination.

This project shows one of the possible ways to implement RESTful API server.

Running

1. Clone repository.

sendify repo

Create and activate a virtual environment

`virtualenv env --python=python3.6`

`source env/bin/activate`

Install required Dependencies

pip install -r requirements.txt

Running the application

$ export FLASK_APP="run.py"
$ export FLASK_ENV="development"
$ flask run

Open postman and use the below endpoints.

Endpoints currently available

Method	Endpoint	Description	User-type
1.POST	/api/v2/parcels	Creates a new parcel order.	customers
2.GET	/api/v2/parcels	Get all parcel orders	admin
3.GET	/api/v2/parcels/int	Get a specific parcel order	customers/admin
4.PUT	/api/v2/parcels/int/destination	Change a parcel's destination	customers
5.PUT	/api/v2/parcels/int/presentloaction	changes parcel current location	admin
5.PUT	/api/v2/parcels/int/status	changes the status of a parcel	admin
6.GET	/api/v2/users/int/parcels	gets parcels by specific users	customer
7.POST	/api/v2/auth/signup	Registers a user to the app	customers
9.POST	/api/v2/auth/login	Logs in a user to the app	Admin/customer

How to test the hosted version:

Heroku app hosted on: https://sendify-app.herokuapp.com/api/v1/ place the different endpoints at the end of the above url to test

Created with 💕 by:

Willies Wanjala