API Docs - Users

Contents

Users

User System

The user system is critical for making requests within your Game DB tables from your game using the API. You can only save data from a users account to a table that is marked as user edited. Through the API you are able to register an account, login as a user and request a forgot password email.

User Creation

user/create

This endpoint will allow you to create a new user login.

Parameters

Parameters to pass with your request. Pass across the username parameter from a text field. Pass across the email parameter from a email field. Pass across the password parameter from a password field.

Responses

These are the responses you can expect to receive depending on the outcome. You will receive a success message if the user has been created. If the username or email has been used already then the error "User already exists." error will be returned. Success Missing fields. User already exists. Unauthorized

Example

See how in this javascript example.

/* Function that will be run on button click */
function submitRegister(){	
    /* Clear div contents with id Response */
    document.getElementById("Response").innerHTML = "";
    /* Collect the input fields values into variables */
    var username = document.getElementById("username").value;
    var email = document.getElementById("email").value;
    var password = document.getElementById("password").value;
       
    /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/user/create";
	/* Your auth token needs to be added here */
	var auth_token = "Paste Your Auth Token here";
	
	/* Open request */
	xhttp.open("POST", url, true);
	/* Auth_token request header for authorisation */
	xhttp.setRequestHeader("auth_token",auth_token);
	/* Set header for passing information across */
	xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
	/* Send request with data */
	xhttp.send("username="+username+"&email="+email+"&password="+password);
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   /* Insert response inside element with id Response */
	   document.getElementById("Response").innerHTML = this.responseText;
	  }
	};
}

User Login

user/auth

This endpoint will allow you to authenticate a user login. Logging in a user successfully will

Parameters

Parameters to pass with your request. Pass across the email parameter from a email field. Pass across the password parameter from a password field.

Responses

These are the responses you can expect to receive depending on the outcome. You will receive an access token if the user successfully logs in. This token needs to be saved to a variable. You will have to pass this variable on as a header named "access_token" in your requests to user authenticated endpoints. The access token Error Unauthorized

Example

See how in this javascript example.

/* Set global variable for access_token */
var access_token;
/* Function that will be run on button click */
function submitLogin(){	
    /* Clear div contents with id Response */
    document.getElementById("Response").innerHTML = "";
    /* Collect the input fields values into variables */
    var email = document.getElementById("email").value;
    var password = document.getElementById("password").value;
       
    /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/user/auth";
	/* Your auth token needs to be added here */
	var auth_token = "Paste Your Auth Token here";
	
	/* Open request */
	xhttp.open("POST", url, true);
	/* Auth_token request header for authorisation */
	xhttp.setRequestHeader("auth_token",auth_token);
	/* Set header for passing information across */
	xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
	/* Send request with data */
	xhttp.send("email="+email+"&password="+password);
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   if(this.responseText == "Unauthorized"){
	       /* On unauthorized insert response inside element with id Response */
	       document.getElementById("Response").innerHTML = this.responseText;
	   } else if(this.responseText == "Error"){
	        /* On error insert an error response inside element with id Response */
	       document.getElementById("Response").innerHTML = "Either user does not exist or your password is incorrect";
	   } else {
	       /* On success insert a success response inside element with id Response */
	       document.getElementById("Response").innerHTML = "You are now logged in.";
	       /* Insert the response into your access_token variable for later requests */
	       access_token = this.responseText;
	   }
	  }
	};
}

User Password Reset

user/reset

This endpoint will allow you to send a request for a password reset for an account. This will send an email for the user if the email is correct to then reset the password.

Parameters

Parameters to pass with your request. Pass across the email parameter from a email field.

Responses

These are the responses you can expect to receive depending on the outcome. Once a successfull request is made an email is sent to the email address initiating a password reset. There is a cool down period until the next email will be able to be sent. Success countdown until another attempt can be made after a successfull request is made. User doesn't exist. Missing email field. Unauthorized

Example

See how in this javascript example.

/* Function that will be run on button click */
function submitReset(){	
    /* Clear div contents with id Response */
    document.getElementById("Response").innerHTML = "";
    /* Collect the input field value into a variable */
    var email = document.getElementById("email").value;
       
    /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/user/reset";
	/* Your auth token needs to be added here */
	var auth_token = "Paste Your Auth Token here";
	
	/* Open request */
	xhttp.open("POST", url, true);
	/* Auth_token request header for authorisation */
	xhttp.setRequestHeader("auth_token",auth_token);
	/* Set header for passing information across */
	xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
	/* Send request with data */
	xhttp.send("email="+email);
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   /* Insert response inside element with id Response */
	   document.getElementById("Response").innerHTML = this.responseText;
	  }
	};
}

Retrieve Username

fetch/username

This endpoint will retrieve the username of the logged in user.

Responses

These are the responses you can expect to receive depending on the outcome. Will bring back the username of the logged in user. Users username is returned.

Example

See how in this javascript example.

/* Set global variable for access_token */
var access_token;
/* Your auth token needs to be added here */
var auth_token = "Paste Your Auth Token here";
	
/* Function that will be run on button click */
function submitLogin(){	
    /* Clear div contents with id Response */
    document.getElementById("Response").innerHTML = "";
    /* Collect the input fields values into variables */
    var email = document.getElementById("email").value;
    var password = document.getElementById("password").value;
       
    /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/user/auth";
	
	/* Open request */
	xhttp.open("POST", url, true);
	/* Auth_token request header for authorisation */
	xhttp.setRequestHeader("auth_token",auth_token);
	/* Set header for passing information across */
	xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
	/* Send request with data */
	xhttp.send("email="+email+"&password="+password);
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   if(this.responseText == "Unauthorized"){
	       /* On unauthorized insert response inside element with id Response */
	       document.getElementById("Response").innerHTML = this.responseText;
	   } else if(this.responseText == "Error"){
	        /* On error insert an error response inside element with id Response */
	       document.getElementById("Response").innerHTML = "Either user does not exist or your password is incorrect";
	   } else {
	       /* On success insert a field and button for our column response inside element with id Response */
	       document.getElementById("Response").innerHTML = "<button onClick=retrieveUsername();>Retrieve Username</button><div id=Username></div>";
	       /* Insert the response into your access_token variable for later requests */
	       access_token = this.responseText;
	   }
	  }
	};
}
/* Function will be run on button click */
function retrieveUsername(){
     /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/fetch/username";
	
	/* Open request */
	xhttp.open("POST", url, true);
	/* Auth_token request header for authorisation */
	xhttp.setRequestHeader("auth_token",auth_token);
	/* Access_token request header for authorisation */
	xhttp.setRequestHeader("access_token",access_token);
	/* Send request with data */
	xhttp.send();
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   	/* Insert response inside element with id Username */
	   	document.getElementById("Username").innerHTML = this.responseText;
	  }
	};
}

SAVING DATA >

API DOCS v1.1

Users

User System

User Creation

user/create

Parameters

Responses

Example

User Login

user/auth

Parameters

Responses

Example

User Password Reset

user/reset

Parameters

Responses

Example

Retrieve Username

fetch/username

Responses

Example