MyGigsters API Documentation

Log in to create an API key

POST/auth/login

This endpoint is to login so you can create an API key. You need to be signed up to MyGigsters first to be able to log in this way.

Request Body

Required: Yes

Content-Type: application/json

Parameter	Type	Description
email *	string	Your email you signed up with MyGigsters

Responses

Content-Type: application/json

Response Code

Description

Schema

200

A User object

Parameter	Type	Description
message	string	Response from server

400

Email not provided

Parameter	Type	Description
errors	string	Error message regarding email

404

Email not found on the system

Parameter	Type	Description
errors	string	Error message regarding email

500

Unknown system error

Parameter	Type	Description
error	string	Error message regarding email

Sample Request - cURL

curl 'https://super.mygigsters.com.au/auth/login' -X POST \
         -H "Content-Type: application/json" --data '{"email":"email@email.com"}'

Sample Response - 200

{
  "message": "OTP sent to your email"
}

Verify OTP received after login

POST/auth/verify-otp

This route returns the JWT for use with API Keys routes (/api-keys/) - note that the OTP is always 123456 for non-production environments

Request Body

Required: Yes

Content-Type: application/json

Parameter	Type	Description
otp *	string	One Time Pin to be sent in string format
email *	string	The email address which you requested the OTP for

Responses

Content-Type: application/json

Response Code

Description

Schema

200

Response with the JWT to use for the rest of the API Keys routes

Parameter	Type	Description
message	string	Information about response
clientId	integer	Client ID of the user
email	string	Email of user
token	string	JWT for use with API Keys routes

400

Missing info in request body

Parameter	Type	Description
errors	string	Information about missing data

404

Cannot find user or invalid OTP

Parameter	Type	Description
message	string	Info about the error

Sample Request - cURL

curl 'https://super.mygigsters.com.au/auth/verify-otp' -X POST \
         -H "Content-Type: application/json" --data '{"otp":"123456","email":"email@email.com"}'

Sample Response - 200

{
  "message": "OTP verified successfully",
  "clientId": 1,
  "email": "idea@woodevelopment.com",
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImV4cCI6MTc2NjQ0MDg3MiwiaWF0IjoxNzY2NDM3MjcyfQ.N5z-MpfLZqwUrD1Cc0Kj2ciZ9i66I5SIDH0C8daFpkcX_VNcZ_I8ZgW_GLTAnwWjdY_J1e7T7FcwPxxK3MwN9_G5vUIuSRlqzVw87NHhZLS6yIL41wSQ2oJjT0esFO8V7FjakiPuU4qc5duXYWyfeqX8faYzxsD4j0o1L7GqoEHqoaVp-RkOXdPSTmveZI7HqdzqXPgRcLprY3E8Bd59JX5oM8ynf8SKy5GOWSh4VsIhOTZsVO9CPhzBPglTUona1ZpWU9JtwRnwI3LxycuosUvwmJJ8w-bGPhUazRcKmRevE1e29nvqNWPa0RH3f4uneSnS4GYJh3APCvblpwWeHBvtvpAXT84RkWv0dKr5QAZh3wFVGvOcLpIwPP0MXwDNYeZTkR_l_tIRUzSeU56H2hC5kj_X5emR-p76mwnY9dIfYZax3aSxMPeHgyTchR3DQUok-DIZvGLoGE731E1Sqc2eC1itjNjaBqsr_DcwPapXljtI01pCrIZ9TXkH4XgyrCtSrFps9uviv28_GMzIgJcJ6J7PTLpdrOGtY3LWe7bKGksTwe2LkQb-Oj2HyUr7GMMOFhw7wMUz_mrUjJ2pJjFi1XrNEwzApx9UJw1dDC7GiQTxJPH9SvL_re6zH0qK99OtKAU9gCczdMkQ29tBGT0HJrpWDyb62E8j9y5C-EU"
}

Adds a new API Key

POST/auth/create

This endpoint creates an API key. The API Key is to be used in Basic Authentication format eg. curl -u "apiUsername:apiPassword". To access this endpoint you need to obtain a JWT via Get OTP and Verify OTP sections.

Request Body

Required: Yes

Content-Type: application/json

Parameter	Type	Description
name *	string	The friendly name for your key - for your reference only

Responses

Content-Type: application/json

Response Code

Description

Schema

200

An API Key object

Parameter	Type	Description
apiUsername	string	The Basic Auth API Key user name
apiPassword	string	The Basic Auth API Key password (only shown once for security)

400

Invalid API Key details

Parameter	Type	Description
error	string	The error message

Sample Request - cURL

curl 'https://super.mygigsters.com.au/auth/create' -X POST \
    -H "Authorization: Bearer JWT_FROM_VERIFY_OTP_STEP"  \
    -H "Content-Type: application/json" --data '{"name":"My Key"}'

Sample Response - 200

{
  "apiUsername": "39534898-f44e-461e-99fb-c27f3bdd515b",
  "apiPassword": "(Qlpej#UXs5NLCS$Rk&+"
}

List your API Keys

GET/auth/list

This endpoint lists API keys. The API Key is to be used in Basic Authentication format eg. curl -u "apiUsername:apiPassword". To access this endpoint you need to obtain a JWT via Get OTP and Verify OTP sections.

Responses

Content-Type: application/json

Response Code

Description

Schema

200

The API Key objects

Parameter	Type	Description
id	string	The API Key ID.
name	string	Friendly name of the API Key
apiUsername	string	The Basic Auth API Key user name

Sample Request - cURL

curl 'https://super.mygigsters.com.au/auth/list' \
    -H "Authorization: Bearer JWT_FROM_VERIFY_OTP_STEP"

Sample Response - 200

[
  {
    "id": "1231412313213",
    "name": "My Key",
    "apiUsername": "29954bf9-c379-4107-8ed6-7af7eaf30981"
  }
]

Deletes an API Key

DELETE/auth/delete-key

This endpoint deletes an API key. To access this endpoint you need to obtain a JWT via Get OTP and Verify OTP sections.

Request Body

Required: Yes

Content-Type: application/json

Parameter	Type	Description
id *	string	The ID of your key (not the friendly name)

Responses

Content-Type: application/json

Response Code

Description

Schema

200

API Key deleted

Parameter	Type	Description
message	string	Success message

204

No Content

400

API Key not provided

Parameter	Type	Description
error	string	Error message

404

API Key not found

Parameter	Type	Description
error	string	Error message

Sample Request - cURL

curl 'https://super.mygigsters.com.au/auth/delete-key' -X DELETE \
    -H "Authorization: Bearer JWT_FROM_VERIFY_OTP_STEP"  \
    -H "Content-Type: application/json" --data '{"id":"1231412313213"}'

Sample Response - 200

{
  "message": "API Key deleted"
}

Sample Response - 204

{}