Memory sharer

Internal function and system design.

There are four main route collections.

• Auth
• User
• Contacts
• Memories

The auth route is used to get authorization-token to access the rest of the API. When calling a route the internal system will:

• Get relevant information from the database
• run the retrieved information and the request information through a layer of rules.
• If the rules are satisfied by the request, the information will be persisted and/or the caller will get the requested information.
• If the rules are not satisfied the caller will get an status code and a message explaining the error.

The rules are built from simple rules that are putted together by the rule assembler.

Server API documentation

The basic url to the server is to be added

Authorization

Authorization can currently be done by the following methods:

• Username and password

If the authorization is successful an jwt-token is received, containing the following:

• Expiration time
• The users guid

The token is to be added to each request against the API.

Route - Login

POST: /auth/login

Parameters

Type	Parameter	value
json	clientId	An id that is distributed by the API-admin
json	password	The users password.
json	username	The users username

Response

200

{
    "token": "<auth key>"
}

400

{
    "error": {
        "code": "INVALID_CLIENT_ID"
    }
}

403

{
    "error": {
        "code": "LOGIN_FAILED"
    }
}

404

{
    "error": {
        "code": "USER_DOES_NOT_EXISTS"
    }
}

User

Route - Get User

GET: /user

Parameters

Type	Parameter	value
Head	Authorization	Bearer <auth token>

Response

200

{
    name: 'Kristoffer',
    guid: "bjbsnjfhdfngjdf4541154dsfds"
    id: 'hgfisds44',
    email: '[email protected]'
}

404

{
    error: {
        code: 'USER_DOES_NOT_EXISTS'   
    }
}

Route - Add User (Not protected)

POST: /user

Parameters

Type	Parameter	value
json	username	'kristoffer'
json	password	'*********'
json	clientId	'client.id.se'

Response

200

{
   "guid": "<guid>"
}

400

{
    "error: {
         code: 'INVALID_USERNAME' | 'INVALID_EMAIL' | INVALID_PASSWORD | INVALID_CLIENT_ID
    }
}

403

{
    "error": {
         "code": "USERNAME_ALREADY_TAKEN"
    }
}

Contacts

Route Get contacts

GET: /contacts

Parameters

Type	Parameter	value
Head	Authorization	Bearer <auth token>

Response

200

[
    {
        "username": "contactname",
        "guid": "s4f754sd2fsfajfdsda54",
        "id": "-L2WrCY1G-N89gRxxXek",
        "email": "[email protected]"
    },
    {
        "username": "contactname2",
        "guid": "4dfgdfgdfgfdg845453d",
        "id": "-L2lk7TNfL3WzGuyoyM1",
        "email": "[email protected]"            
    }
    ...
]

Route Add contact to user

POST: /contacts

This functionality should be changed so that the added contact must accept the adder.

Parameters

Type	Parameter	value
Head	Authorization	Bearer <auth token>
json	contactGuid	dsfhiuhsdf46574dfs7486sd4

Response

200

{
    "contactList": [
        "dfks4sdfsdf854fdsfsd",
        "dsf4dsfg7sdr48g6vdg7fd6",
        "sd45gfd6f4ds68f54ds6f8s4",
        "dsfhiuhsdf46574dfs7486sd4"  // <-- New contact
    ]
}

400

"error" {
    "code": ALREADY_A_CONTACT
}

404

{
    "error": {
         "code": USER_DOES_NOT_EXISTS | CONTACT_DOES_NOT_EXISTS
    }
}

Memory

Route - Get memories sent by user.

GET: /memories/sent

Parameters

Type	Parameter	value
Head	Authorization	Bearer <auth token>
json	contactGuid	dsfhiuhsdf46574dfs7486sd4

Response

200

[
    {
        "guid": "memory-1519512694957445",
        "filePath": "public\\images\\memory-1519512694957445.jpg",
        "message": "Hello, and look att this!",
        "recipients": [
            "1tb642H6453nD57R16by83Q5au6mw6E15",
            "5784ddff42H6453gdgweygtas7gh8dfsE"
        ],
        "sender": "Ceu0I78uW0RC52B5UtuiKe4K6vF5LNqt6"
    },
    {
        "guid": "memory-1519513401034576",
        "filePath": "public\\images\\memory-1519513401034576.jpg",
        "message": "Wat about a grasshopper for dinner?",
        "recipients": [
            "1tb642H6453nD57R16by83Q5au6mw6E15"
        ],
        "sender": "Ceu0I78uW0RC52B5UtuiKe4K6vF5LNqt6"
    }
]

Route - Get memory image

GET: /image/?filePath=....

Parameters

Type	Parameter	value
Head	Authorization	Bearer <auth token>
GET (query param)	filePath	"public\\images\\memory-1519512694957445.jpg"

Response

200

image

400

{
    "error": {
        "code": "INVALID_IMAGE" // The requested file does not exist or can not be accessed
    }
}

Route - Add memory

POST: baseURL/memory

Parameters

Type	Parameter	value
Head	Authorization	Bearer <auth token>
Post	memory	Image (.png or .jpeg
Post	recipients	[<guid>, <guid>,...]
Post	message	"Hello there!"

Response

200

{
    "failedToSendTo": []
}

400

{
    "error": {
        "code": "INVALID_IMAGE"
    }
}

404

{
    "error": {
        "code": "USER_DOES_NOT_EXISTS"
    }
}