Basic Login

You can use this endpoint to complete a basic login to the system. This allows you to submit your email address and password and the response includes a webservice token that you can use for accessing other API endpoints. For the moment, you can just use your own credentials for this end-point for for multi-user access, we will extend this functionality to allow for Application Keys

POST /index.php/api/login HTTP/1.1

Host: https://api.noster.info

Arguments

The login end-point takes the following arguments. Remember that for login end points, all arguments must be POSTed

Name Description Type Options
email The email address associated with the login account Text
password The password for the account Text
format The format in which we want the data returned Enum json,xml

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}
Facebook Login

You can use this endpoint to complete a facebook login to the system. This works in conjunction with the Facebook login button or iOS/Android library. The idea is to allow you to validate a Facebook user ID and access token and thus grant access to the validated user. If the email address associated with the Facebook user or the facebook user ID is in the system, and the access token validates, then that user will be granted access to the API based on the validation. By providing an email address and password, this API allows you to attach a facebook account to a previously logged in user. See Facebook developer documentation for more details.

POST /index.php/api/login_facebook HTTP/1.1

Host: https://api.noster.info

Arguments

Name Description Type Options
facebook_id The Facebook ID of the user logging in Bigint
facebook_token The Facebook access token of the user logging in. This is obtained from the facebook login button. Text
format Optional - The format in which we want the data returned Enum json,xml
user_id Optional - The ID of the user accessing the API Call Integer
session_key Optional - The session key returned for the user when logging in Text

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}
Twitter Login

You can use this endpoint to complete a Twitter login to the system. This works in conjunction with the Twitter login button or iOS/Android library. The idea is to allow you to validate a Twitter user ID and access token and thus grant access to the validated user. If the Twitter user ID is in the system, and the access token validates, then that user will be granted access to the API based on the validation. By providing an email address and password, this API allows you to attach a facebook account to a previously logged in user. See Twitter developer documentation for more details.

POST /index.php/api/login_twitter HTTP/1.1

Host: https://api.noster.info

Arguments

Name Description Type Options
twitter_id The Twitter ID of the user logging in Bigint
twitter_handle The Twitter handle of the user logging in Bigint
twitter_token The Twitter access token of the user logging in. This is obtained from the facebook login button. Text
twitter_secret The Twitter secret of the user logging in. This is obtained from the facebook login button. Text
format Optional - The format in which we want the data returned Enum json,xml
user_id Optional - The ID of the user accessing the API Call Integer
session_key Optional - The session key returned for the user when logging in Text

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}
Instagram Login

You can use this endpoint to complete a Instagram login to the system. This works in conjunction with the Instagram login button or iOS/Android library. The idea is to allow you to validate a Instagram user ID and access token and thus grant access to the validated user. If the Instagram user ID is in the system, and the access token validates, then that user will be granted access to the API based on the validation. By providing an email address and password, this API allows you to attach a facebook account to a previously logged in user. See Instagram developer documentation for more details.

POST /index.php/api/login_instagram HTTP/1.1

Host: https://api.noster.info

Arguments

Name Description Type Options
instagram_id The Instagram ID of the user logging in Bigint
instagram_token The Instagram access token of the user logging in. This is obtained from the instagram login button. Text
format Optional - The format in which we want the data returned Enum json,xml
user_id Optional - The ID of the user accessing the API Call Integer
session_key Optional - The session key returned for the user when logging in Text

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}