Skip to main content

API Unified Definition

The common definition used in all AppSeed products that includes an API Service

This page describes the unified definition used by all API servers provided by AppSeed. This internal standard is used by all full-stack products, despite the UI or backend technology.

API Servers aligned to use it:

API Information​

Interface descriptor - POSTMAN collection format

  • USERS API:
    • /api/users/register: create a new user
    • /api/users/login: authenticate an existing user
    • /api/users/logout: delete the associated JWT token
    • /api/users/checkSession: check an existing JWT Token for validity
    • /api/users/edit - edit the information associated with a registered user

API Samples​

👉 Register - api/users/register

POST api/users/register
Content-Type: application/json

{
    "username":"test",
    "password":"pass",
    "email":"test@appseed.us"
}

👉 Login - api/users/login

POST /api/users/login
Content-Type: application/json

{
    "password":"pass",
    "email":"test@appseed.us"
}

👉 Logout - api/users/logout

POST api/users/logout
Content-Type: application/json
authorization: JWT_TOKEN (returned by Login request)

{
    "token":"JWT_TOKEN"
}

✅ Resources​