Skip to content

SFerguson90/APlaceForUsAPI

Repository files navigation

APlaceForUs API

First Use - Creating an Account

To use the API, an account must first be created. This happens through a POST request to the /users endpoint. Users can feel safe, knowing their passwords are SHA256 encrypted when stored in the database.

NewUserCreated

Email Verification with Mailgun API

After having created an account, the user will be sent a verification email to their email address. Be sure to check the spam folder!

MailGunAPI

Logging in and receiving a JSON Web Token

By passing email and password as keys with their respective values to the /tokens endpoint, a user is given a Bearer access token, with which they can log in.

LoginSuccess

Post your dog!

Once an account is created and the user has logged in, they may share their dog's information!

DogPostSuccess

Change your avatar

Don't like your avatar picture? Let's change it!

AvatarChangePict

Deployed and running on Heroku

All of this is available from the Heroku platform! On the right, you'll notice the default avatar picture, a friendly picture of Bear! Towards the bottom, you'll notice the User table in pgAdmin 4, with the passwords safely encrypted.

HerokuPict

HTTP Methods - as of 9/10/2021

These are all of the HTTP methods tested and available to users. Many have JWT (JSON Web Token) Requirements. This authentication prevents manipulation and provides basic security.

HTTPMethods

Technical Information

  • Language: Python 3.7
  • Framework: Flask 1.0.3
  • Database: PostgreSQL / pgAdmin 4
  • Tested With: Postman

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published