/short-messages-web-api

Simple Web API in .NET Core for sending and receiving short messages.

Primary LanguageC#MIT LicenseMIT

Welcome to the Short Messages Web Api

This simple web API is designed for the course "Sicherheit von Netwerken und mobilen Applikationen" on the University of Applied Sciences Technikum Wien.

You can reach the API at: https://short-messages-web-api.azurewebsites.net

Or you can view the API with Swagger: https://short-messages-web-api.azurewebsites.net/swagger/

The API

The Web API provides two methods, get and post. A client can post one or several ShortMessages via POST. Via GET he can access all his posted ShortMessages. The API supports multiple clients with the consumer key. When a client first posts a ShortMessage with a customer key and a customer secret, a single list of ShortMessages is assigned to this client. Following ShortMessages with the same combination of key and secret are added to the same list.

You can run sample request with postman:

Run in Postman

In folder /java You can find Java example classes for the use of this API with Retrofit and GSON.

Get short messages for the consumer key

Returns ShortMessages for the passed String consumerKey

The url schema: // GET api/ShortMessages/{consumerkey}

Post a new short message

You can post new short messages via this method. It expects a IncomingShortMessageModel. It returns the currently saved ShortMessageModel.

The url schema: // POST api/ShortMessages