Giter VIP home page Giter VIP logo

API DOCUMENTATION

access_token

you need access_token for access the api, you can obtain access_token by access https://raflirach.herokuapp.com/token or you can use :

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6InJhZmxpcmFjaCIsImlhdCI6MTYxNTM3MjQxNX0.mDMs7pRNc9ihIi5bty7Fm4z2A2ZzX6l6FTljCDcm7Nk

Endpoint

  • GET /token
  • GET /users
  • GET /users/{id}
  • GET /users/account/{accountNumber}
  • GET /users/identity/{identityNumber}
  • POST /users
  • PUT /users/{id}
  • DELETE /users/{id}

GET TOKEN

  • URL

    /token

  • Method

    GET

  • Success Response:
    Code: 200
    Content:

    {
      "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6InJhZmxpcmFjaCIsImlhdCI6MTYxNTM3NDU2NH0.SFATwBd0YAa-XRNP-wH3hcowrtJg0jhAsvMqfw-ec3Y"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

Show List User

  • URL

    /users

  • Method

    GET

  • Request Headers

    {
      access_token : <your access_token>
    }
    
  • Success Response:
    Code: 200
    Content:

    [
      {
          "_id": "604898a72838f34c1e116de6",
          "userName": "raflirach",
          "accountNumber": "123456788",
          "emailAddress": "[email protected]",
          "identityNumber": "320120603950002"
      },
      {
          "_id": "60489a9d8844cc4f05c16361",
          "userName": "agus",
          "accountNumber": "123333112",
          "emailAddress": "[email protected]",
          "identityNumber": "320120603950009"
      }
    ]
    
  • Failed Response:
    Code: 403
    Content:

    {
      "status": "error",
      "message": "invalid access_token"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

GET USER BY ID

  • URL

    /users/{id}

  • Method

    GET

  • Request Headers

    {
      access_token : <your access_token>
    }
    
  • Success Response:
    Code: 200
    Content:

    {
      "_id": "604898a72838f34c1e116de6",
      "userName": "raflirach",
      "accountNumber": "123456788",
      "emailAddress": "[email protected]",
      "identityNumber": "320120603950002"
    }
    
  • Failed Response:
    Code: 403
    Content:

    {
      "status": "error",
      "message": "invalid access_token"
    }
    

    Code: 404
    Content:

    {
      "status": "error",
      "message": "data not found"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

GET USER BY ACCOUNT NUMBER

  • URL

    /users/account/{accountNumber}

  • Method

    GET

  • Request Headers

    {
      access_token : <your access_token>
    }
    
  • Success Response:
    Code: 200
    Content:

    {
      "_id": "604898a72838f34c1e116de6",
      "userName": "raflirach",
      "accountNumber": "123456788",
      "emailAddress": "[email protected]",
      "identityNumber": "320120603950002"
    }
    
  • Failed Response:
    Code: 403
    Content:

    {
      "status": "error",
      "message": "invalid access_token"
    }
    

    Code: 404
    Content:

    {
      "status": "error",
      "message": "data not found"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

GET USER BY IDENTITY NUMBER

  • URL

    /users/identity/{identityNumber}

  • Method

    GET

  • Request Headers

    {
      access_token : <your access_token>
    }
    
  • Success Response:
    Code: 200
    Content:

    {
      "_id": "604898a72838f34c1e116de6",
      "userName": "raflirach",
      "accountNumber": "123456788",
      "emailAddress": "[email protected]",
      "identityNumber": "320120603950002"
    }
    
  • Failed Response:
    Code: 403
    Content:

    {
      "status": "error",
      "message": "invalid access_token"
    }
    

    Code: 404
    Content:

    {
      "status": "error",
      "message": "data not found"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

POST USER

  • URL

    /users

  • Method

    POST

  • Request Headers

    {
      access_token : <your access_token>
    }
    
  • Request Body

    {
      "userName": "raflirach",
      "accountNumber": "123456788",
      "emailAddress": "[email protected]",
      "identityNumber": "320120603950002"
    }
    
  • Success Response:
    Code: 201
    Content:

    {
      "_id": "604898a72838f34c1e116de6",
      "userName": "raflirach",
      "accountNumber": "123456788",
      "emailAddress": "[email protected]",
      "identityNumber": "320120603950002"
    }
    
  • Failed Response:
    Code: 400
    Content:

    {
      "status": "error",
      "message": "identityNumber 320120603950002 already registered"
    }
    

    Code: 403
    Content:

    {
      "status": "error",
      "message": "invalid access_token"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

EDIT USER

  • URL

    /users/{id}

  • Method

    PUT

  • Request Headers

    {
      access_token : <your access_token>
    }
    
  • Request Body

    {
      "userName" : "raflirach",
      "accountNumber" : "123123122",
      "emailAddress" : "[email protected]",
      "identityNumber" : "320120603950002"
    }
    
  • Success Response:
    Code: 200
    Content:

    {
      "userName": "raflirach",
      "accountNumber": "123123122",
      "emailAddress": "[email protected]",
      "identityNumber": "320120603950002",
      "_id": "604898a72838f34c1e116de6"
    }
    
  • Failed Response:
    Code: 400
    Content:

    {
      "status": "error",
      "message": "identityNumber 320120603950002 already registered"
    }
    

    Code: 403
    Content:

    {
      "status": "error",
      "message": "invalid access_token"
    }
    

    Code: 404
    Content:

    {
      "status": "error",
      "message": "data not found"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

DELETE USER

  • URL

    /users/{id}

  • Method

    DELETE

  • Request Headers

    {
      access_token : <your access_token>
    }
    
  • Success Response:
    Code: 200
    Content:

    {
      "message": "user deleted successfully"
    }
    
  • Failed Response:
    Code: 403
    Content:

    {
      "status": "error",
      "message": "invalid access_token"
    }
    

    Code: 404
    Content:

    {
      "status": "error",
      "message": "data not found"
    }
    

    Code: 500
    Content:

    {
      "status": "Error",
      "error": <internal server error>
    }
    

Rafli Rachmawandi's Projects

api icon api

Restful API with laravel

fancy-todo icon fancy-todo

Membuat website untuk mencatat hal - hal menarik untuk dilakukan

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.