RikiTrakiWS

This repository contains the code for the web services supporting RikiTraki, a outdoor activities log web application: RikiTraki.com. The public Web Services and database are hosted in Google Cloud Platform. The data is maintained on a MongoDB database to which this project provides a CRUD interface using REST web services.

Self Hosting

If you want to host your own Web Services layer:

• npm install

• Install and run MongoDB

• Unzip rikitraki_dump.zip (located in emptydb directory of this repo) in some working directory

• Run mongorestore dump (MongoDB must be up and running) which will create the rikitraki database with the required collections and index definitions

• Run node rikitrakiws.js, ensuring that the following environment variables are set prior:

• MONGODB_DB_URL, for example, export MONGODB_DB_URL=mongodb://localhost:27017/rikitraki

• MAILGUN_API_KEY, for example, MAILGUN_API_KEY=key-thisismymailgunapikey -- this is required to be able to add users that can upload tracks to the database

• JWT_SECRET, the service needs to sign authentication tokens; this should be a long random password, for example export JWT_SECRET=thisisaverylongrandompasswordforsigningjwttokens

• The script start.sh is an example of a start script that grabs secrets from the Google Cloud Platform metadata storage and sets the environment variable above

• Make sure your rikitraki client is configured to point to your running web service (file js/config.js, getApiBaseUrl entry); for example: http://localhost:3000/api

• Create a new user using the rikitraki application and start adding tracks

Note: the above has been tested with MongoDB v3.6.3 and node v12.10.0

API:

URL Format: {service-url}/api/{version}/{resource}, e.g., : https://www.rikitraki.com/api/v1/tracks/'

All results in JSON format except images and GPX files.

SSL is required on all authenticated/authorized calls.

Resources

Resource	Verb	Description	Status Codes
/token	GET	Retrieves a new JWT token for API calls that require authorization. Requires basic authentication (userid/password)	200: Success 401: Unauthorized
/resettoken/?email={emai}&rturl={url}	GET	Requests a JWT token to be used for password reset. Parameter email is the address of the user to which the token will be sent. Parameter rturl is the url of the password reset page which is emailed as a link.	200: Success 404: User not found
/users	POST	Registers a new user. Requires a valid inviation code associated with a submitted email address. Returns username (same as submitted)	201: Success 400: Invalid input 401: Unauthorized 404: Missing invitation code 422: Duplicate 507: Database error
/users/me	GET	Retrieves user profile information for the user in the embedded JWT token. Requires a valid JWT token in the header (Authorization: JWT {token})	200: Success 401: Unauthorized 404: User not found
/users/me	PUT	Updates user profile information. Requires a valid JWT token in the header (Authorization: JWT {token})	204: Success 400: Invalid input 401: Unauthorized 404: User not found 422: Duplicate email address 507: Database error
/users/{username}	PUT	Updates user password. Requires a valid JWT reset token in the header (Authorization: JWT {token})	204: Success 400: Invalid input 401: Unauthorized 507: Database error
/invitation	POST	Requests an invitation to be emailed to the address submitted in the body.	204: Success 400: Invalid input 429: Invitation count exceeded
/tracks/	GET	Returns the latest MAX_TRACKS (limit 5000)	200: Success 404: Not found
/tracks/?filter={filter expression}	GET	Returns latest MAX_TRACKS (limit 5000) that match filter expression.	200: Success 404: Not found
/tracks/?latlng={lat},{long}&distance={d}	GET	Returns a list of tracks near a given location by a given distance in meters.	200: Success 404: Not found
/tracks/?proj=small	GET	Returns abbreviated version of track list. Can be combined with geospatial search above.	200: Success 404: Not found
/tracks/	POST	Creates a new track. JSON document in body. Requires a valid JWT token in the header (Authorization: JWT {token}). Returns trackId.	201: Success 400: Invalid input 401: Unauthorized 507: Database error
/tracks/{trackId}	PUT	Updates track info. JSON document in body. Requires a valid JWT token in the header (Authorization: JWT {token}). Returns trackId.	200: Success 400: Invalid input 401: Unauthorized 403: Forbidden 507: Database error
/tracks/{trackId}	DELETE	Deletes track and associated images. Requires a valid JWT token in the header (Authorization: JWT {token}).	204: Success 401: Unauthorized 403: Forbidden 507: Database error
/tracks/{trackId}	GET	Returns a single track.	200: Success 404: Not found
/tracks/{trackId}/geotags	GET	Returns the list of photo geotags for a given track.	200: Success 404: Not found
/tracks/{trackId}/GPX	GET	Returns the GPX file associated with a given track in application/gpx+xml format.	200: Success 404: Not found
/tracks/{trackId}/thumbnail/{picIndex}	GET	Returns a thumbnail picture for index picIndex in image/jpeg format.	200: Success 404: Not found
/tracks/{trackId}/picture/{picIndex}	GET	Returns a picture for index picIndex in image/jpeg format.	200: Success 404: Not found
/tracks/{trackId}/picture/{picIndex}	POST	Uploads a picture for index picIndex in image/jpeg format.	201: Success 404: Not found 507: Database error

NOTE: RikiTrakiWS is in beta