REST API interface for the Smart Mirror Database
In order to run the tests, you have to restore the dependencies of the project. This can be done using the .NET cli.
cd WebApi.Test
dotnet restore
dotnet test
To run the REST API locally, you need to set a MongoDB Server in the appsettings.json configuration. By default the REST Api tries to connect to localhost with user and password credentials.
cd WebApi
dotnet restore
dotnet run
REST API Base URL: https://sm-webapi.azurewebsites.net/api
The postman.json in the root directory of project can be imported into Postman to test the REST calls against the SmartMirror API. Please ensure to use the POST login action in the /api/auth folder of the collection, to create the JW-Token. The JWT will automatically written to the environment variables of postman and used to authenticate subsequent API calls.
The application uses JWT to authenticate requests made to the REST API. The Token has to be passed in the Authorization-Header with Bearer-Scheme.
Registers a new User. The Password has to be MD5 hashed.
Header: No Header required
Body:
{
"Email": "[email protected]",
"Name": "Cem Basoglu",
"Password": "098f6bcd4621d373cade4e832627b4f6"
}
- Status 400: Bad Request (malformed request body, email in use)
- Status 200: Ok
Some API calls requires an authenticated user in order to fullfill the request. This method is used to create an JW-Token for the given username and password. The Password has to be MD5 hashed.
Header: No Header required
Body:
{
"User": "[email protected]",
"Password": "098f6bcd4621d373cade4e832627b4f6"
}
- Status 400: Bad Request (malformed request body)
- Status 401: Unauthorized (invalid user, password)
- Status 200:
{
"user": "[email protected]",
"name": "Cem Basoglu",
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkNlbSBCYXNvZ2x1IiwiZW1haWwiOiJjZW1AYmFzb2dsdS5kZSIsIm5iZiI6MTQ5NjgyMTMyMywiZXhwIjoxNDk2ODI0OTIzLCJpYXQiOjE0OTY4MjEzMjMsImlzcyI6IlNtYXJ0IE1pcnJvciIsImF1ZCI6IlNtYXJ0IE1pcnJvciBBdWRpZW5jZSJ9.P_oSjsA43t-nNncIeCWbe-fasoFFdy9gX0WScowt-mE"
}
To verify that an given JWT is still valid, this API call can be used to get the current authenticated user.
Header: Authorization: Bearer {token}
Body: No Body required
- Status 401: Unauthorized (no, invalid or expired token)
- Status 200:
{
"name": "Cem Basoglu",
"email": "[email protected]",
}
The Ticket Collection is used to register new mirrors. Every mirror has to be registered, before it can be used with Smart Mirror REST API. To register a new mirror, you have to create a registration ticket. The Number can than be used, to link the mirror with the users account.
Creates a registration ticket.
Header: No authentication required Body: No body required
- Status 400: Bad Request (invalid id)
- Status 200 (WebApi.DataLayer.Models.Ticket):
{
"Number": "A7Z4FH",
"MirrorId": "5f772e8c-392c-4c7f-a38b-2bee3bddb6fb"
}
Registers a new mirror and links it to the authenticated User.
Header: Authorization: Bearer {token} Body: No body required
- Status 400: Bad Request (invalid number, ticket not exists, mirror already registered)
- Status 401: Unauthorized (no authentication header)
- Status 200 (WebApi.DataLayer.Models.Mirror):
{
"Id": "5f772e8c-392c-4c7f-a38b-2bee3bddb6fb",
"User": "[email protected]",
"Name": "My Mirror",
"Image": "https://url.to/image.png",
"Widgets": []
}
The mirror collection can be used to read, update and delete mirrors.
Gets all mirrors for the authenticated User.
Header: Authorization: Bearer {token} Body: No body required
- Status 401: Unauthorized (no authentication header)
- Status 200: (Array of WebApi.DataLayer.Models.Mirror)
[
{
"Id": "5f772e8c-392c-4c7f-a38b-2bee3bddb6fb",
"User": "[email protected]",
"Name": "My Mirror",
"Image": "https://url.to/image.png",
"Widgets": [
{
"Name": "Breaking News",
"Type": 1,
"WidgetSide": 1,
"Order": 2,
"Setting": {
"Feeds": ["https://news.prodiver/rss.xml", "https://news.prodiver/rss.xml", "https://news.prodiver/rss.xml"]
}
},
{
"Name": "Weather",
"Type": 2,
"WidgetSide": 1,
"Order": 1,
"Setting": {
"City": "Minden",
"AccessToken": "accesstokenforweatherprovider"
}
}
]
}
]
Returns a mirror by id.
Header: No authentication required. Body: No body required.
- Status 400: Bad Request (invalid id)
- Status 404: Not Found (mirror with id does not exists)
- Status 200 (WebApi.DataLayer.Models.Mirror):
{
"Id": "5f772e8c-392c-4c7f-a38b-2bee3bddb6fb",
"User": "[email protected]",
"Name": "My Mirror",
"Image": "https://url.to/image.png",
"Widgets": [
{
"Name": "Breaking News",
"Type": 1,
"WidgetSide": 1,
"Order": 2,
"Setting": {
"Feeds": ["https://news.prodiver/rss.xml", "https://news.prodiver/rss.xml", "https://news.prodiver/rss.xml"]
}
},
{
"Name": "Weather",
"Type": 2,
"WidgetSide": 1,
"Order": 1,
"Setting": {
"City": "Minden",
"AccessToken": "accesstokenforweatherprovider"
}
}
]
}
Updates an existing mirror.
Header: No authentication required. Body:
{
"Id": "5f772e8c-392c-4c7f-a38b-2bee3bddb6fb",
"User": "[email protected]",
"Name": "My Mirror",
"Image": "https://url.to/image.png",
"Widgets": [
{
"Name": "Breaking News",
"Type": 1,
"WidgetSide": 1,
"Order": 2,
"Setting": {
"Feeds": ["https://news.prodiver/rss.xml", "https://news.prodiver/rss.xml", "https://news.prodiver/rss.xml"]
}
},
{
"Name": "Weather",
"Type": 2,
"WidgetSide": 1,
"Order": 1,
"Setting": {
"City": "Minden",
"AccessToken": "accesstokenforweatherprovider"
}
}
]
}
- Status 400: Bad Request (malformed body)
- Status 401: Unauthorized (no authentication header)
- Status 404: Not Found (mirror with id does not exists)
- Status 200: Ok
Deletes an existing mirror.
Header: Authorization: Bearer {token} Body: No body required
- Status 400: Bad Request (invalid id)
- Status 401: Unauthorized (no authentication header)
- Status 404: Not Found (mirror with id does not exists)
- Status 200: Ok