Giter VIP home page Giter VIP logo

mockauth's Introduction

MockApp API documentation

Created by Muhammad Ali Mazhuda


You can import Postman collection from file

MockApp.postman_collection.json

1. Login

  • method : POST

  • header : none

  • request params : none

  • request body :

    No Name Type Mandatory
    1 email String required
    2 password String required
  • Success response :

    Account is activated
    {
        "error": false,
        "message": "Successfully logged in",
        "payload": {
            "token": "xxxxxxxxxxxxxxxxxxxxxxxxx"
        }
    }
    
    Account is not activated
    {
        "error": false,
        "message": "Please activate your account",
        "payload": {
            "email": "[email protected]"
        }
    }
    
  • Error response :

    Error Code : 400(Bad Request)
    {
        "error": true,
        "message": "Email or password must be provided"
    }
    
    Error Code : 404(Not Found)
    {
        "error": true,
        "message": "Invalid email or password"
    }
    

2. Register

  • method : POST

  • header : none

  • request params : none

  • request body :

    No Name Type Mandatory
    1 fullName String required
    2 email String required
    3 password String required
  • Success response :

    {
        "error": false,
        "message": "Successfully registered an account, please check your email inbox or spam to activate your account",
        "payload": {
            "email": "[email protected]"
        }
    }
    
  • Error response :

    Error Code : 409(Conflict)
    {
        "error": true,
        "message": "Email is already registered"
    }
    
    Error Code : 400(Bad Request)
    {
        "error": true,
        "message": "Fullname, email and password must be provided"
    }
    

3. Send Verification Code

  • method : POST

  • header : none

  • request params : none

  • request body :

    No Name Type Mandatory
    1 email String required
  • Success response :

    {
        "error": false,
        "message": "Verification code has been sent to your email"
    }
    
  • Error response :

    Error Code : 400(Bad Request)
    {
        "error": true,
        "message": "Email must be provided"
    }
    
    Error Code : 404(Not Found)
    {
        "error": true,
        "message": "Invalid email"
    }
    

4. Activate Account

  • method : POST

  • header : none

  • request params : none

  • request body :

    No Name Type Mandatory
    1 email String required
    2 verificationCode Number required
  • Success response :

    Account is not activated
    {
        "error": false,
        "message": "Account successfully activated"
    }
    
    Account is activated
    {
        "error": false,
        "message": "Account is already activated"
    }
    
  • Error response :

    Error Code : 400(Bad Request)
    {
        "error": true,
        "message": "Email and verification code must be provided"
    }
    
    Error Code : 404(Not Found)
    {
        "error": true,
        "message": "User not found"
    }
    
    Error Code : 404(Not Found)
    {
        "error": true,
        "message": "Invalid verification code"
    }
    

4. Forgot Password

  • method : POST

  • header : none

  • request params : none

  • request body :

    No Name Type Mandatory
    1 email String required
  • Success response :

    {
        "error": false,
        "message": "Reset password has been sent to your email"
    }
    

5. Form Reset Password

6. Reset Password

  • method : POST

  • header : none

  • request params : none

  • request body :

    No Name Type Mandatory
    1 email String required
    2 newPassword String required
  • Success response :

    {
        "error": false,
        "message": "Succesfully reset your password"
    }   
    
  • Error response :

    Error Code : 400(Bad Request)
    {
        "error": true,
        "message": "Email and newPassword must be provided"
    }
    
    Error Code : 404(Not Found)
    {
        "error": true,
        "message": "User not found"
    }
    

mockauth's People

Contributors

mazda94 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.