API documentation

User

- POST
  
  /v1/user/login
  
  Login in system

Parameter	Data type	Example value	Description
username	string	nobody	-
password	string	mySimplePassword	-

Header parameters

Parameter	Data type	Example value	Description
language	string	bg	-

Query parameters

Parameter	Data type	Example value	Description
email	string	pop@armenia.com	User email
age	string	18	User age
city	string	Sofia	User city

PUT

/v1/user/:_id

Edit user details

Authorization

Bearer Token (JWT)

Header parameters

Parameter	Data type	Example value	Description
language	string	bg	Response language
Custom-Header-Name	string	none	Just something for test

Path parameters

Parameter	Data type	Example value	Description
_id	string	641ec45e6c4be0c99ab37035	User ID

Body parameters - Object

Parameter	Data type	Example value	Description
age	number	23	-
address	object		-
city	string	Pleven	-
street	object		-
name	string	Grenadirska	-
number	number	18	-
interests	array of strings	sport	-

Example body

{
    "age": 23,
    "address": {
        "city": "Pleven",
        "street": {
            "name": "Grenadirska",
            "number": 18
        }
    },
    "interests": [
        "sport",
        "music"
    ]
}

DELETE

/v1/user/:_id

Remove single user

Authorization

Bearer Token (JWT)

Header parameters

Parameter	Data type	Example value	Description
language	string	bg	-

Path parameters

Parameter	Data type	Example value	Description
_id	string	641ec45e6c4be0c99ab37035	User ID

Auth

- PATCH
  
  /v1/basic
  
  Example when use basic authorization
- GET
  
  /v1/digest
  
  Example when use digest authorization

GET

/v1/api-key

Example when use API KEY authorization

Authorization

API Key with key API_KEY and value type string. Must be added in Query params

Header parameters

Parameter	Data type	Example value	Description
language	string	bg	-

Query parameters

Parameter	Data type	Example value	Description
date	string	1955-11-05	-