API Docs - Saving Data

Contents

Saving Data

Introduction

When it comes to a database. Its primary purpose is to allow you to save data into it and to then retrieve that data. As we need data to be able to retrieve it you should run through this section first.

So what we will be doing in this section is sending data to an end point allowing the data to be saved as a new row in the database.

For you to be able to do this you will need to setup a table and add some columns to that table winthin gameDB.

Creating a New Row

data/add

This endpoint will allow you to save data as a row to a table.

Parameters

Parameters to pass with your request.

You will need to specify which table you would like to save to. This requires that the table is set to a user edited table in the table settings within Game DB (The table name will be blue if set correctly instead of white) as only user edited tables are allowed to be saved to through the API. This means you will need to be logged in as a user to make a request. You will have to specifiy the columns you want to fill. Any columns within the table not specified will be saved with null by default.

Specify the table name that you would like to post the data to. The column parameter name must be the same as your column's name equal to the value you would like to set, E.g name=John.

Responses

These are the responses you can expect to receive depending on the outcome. Success Unauthorized No table specified No table found

Example

See how in this javascript example.

In the below example you must first make a table called "exampleTable" with a linked column called "exampleColumn" and "exampleColumn2" within Game DB.

/* 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 = "<input type=text id=exampleColumn value=column1><input type=text id=exampleColumn2 value=column2><button onClick=submitData();>Submit Value</button><div id=Error></div>";
	       /* Insert the response into your access_token variable for later requests */
	       access_token = this.responseText;
	   }
	  }
	};
}
/* Function will be run on button click */
function submitData(){
    /* Collect the input fields values into variables */
    var columnValue = document.getElementById("exampleColumn").value;
    var columnValue2 = document.getElementById("exampleColumn2").value;
    
     /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/data/add";
	
	/* 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);
	/* Set header for passing information across */
	xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
	/* Send request with data */
	xhttp.send("table=exampleTable&exampleColumn="+columnValue+"&exampleColumn2="+columnValue2);
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   if(this.responseText == "Success"){
	   	/* Clear div contents with id Response */
       	document.getElementById("Response").innerHTML = "";
	   	/* Insert response inside element with id Response */
	   	document.getElementById("Response").innerHTML = this.responseText;
	   } else {
	   	/* Insert response inside element with id Error */
	   	document.getElementById("Error").innerHTML = this.responseText;
	   }
	  }
	};
}

Editing an Existing Row

data/edit

This endpoint will allow you to edit a rows value for a specific column.

Parameters

Parameters to pass with your request.

You will need to specify which table you would like to edit, which column and which row by id. The row being edited must belong to the user that your logged in as.

Specify the table name that you would like to edit the data of. Specify the column name that you would like to edit the value of. Specify the row id that you would like to edit. Specify the value to change to.

Responses

These are the responses you can expect to receive depending on the outcome. Success Unauthorized Row either does not exist or does not belong to this user Row not specified Column not found Column not specified Table not found No table or value specified

Example

See how in this javascript example.

In this example I'm expecting for you to have run through the last example. Check Game DB for the row ID and let's attempt to change the value of column "columnValue2".

/* 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 = "<input type=text id=row_id placeholder=id><input type=text id=exampleColumn2 value=newValue><button onClick=submitEdit();>Submit Value</button><div id=Error></div>";
	       /* Insert the response into your access_token variable for later requests */
	       access_token = this.responseText;
	   }
	  }
	};
}
/* Function will be run on button click */
function submitEdit(){
    /* Collect the input fields values into variables */
    var row_id = document.getElementById("row_id").value;
    var columnValue2 = document.getElementById("exampleColumn2").value;
    
     /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/data/edit";
	
	/* 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);
	/* Set header for passing information across */
	xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
	/* Send request with data */
	xhttp.send("table=exampleTable&row_id="+row_id+"&column=exampleColumn2&value="+columnValue2);
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   if(this.responseText == "Success"){
	   	/* Clear div contents with id Response */
       	document.getElementById("Response").innerHTML = "";
	   	/* Insert response inside element with id Response */
	   	document.getElementById("Response").innerHTML = this.responseText;
	   } else {
	   	/* Insert response inside element with id Error */
	   	document.getElementById("Error").innerHTML = this.responseText;
	   }
	  }
	};
}

Removing a Row

data/remove

This endpoint will allow you to remove a row for a user.

Parameters

Parameters to pass with your request.

You will need to specify which table you would like to edit and which row by id. The row being edited must belong to the user that your logged in as.

Specify the table name that you would like to edit the data of. Specify the row id that you would like to edit.

Responses

These are the responses you can expect to receive depending on the outcome. Success Unauthorized Row either does not exist or does not belong to this user Row not specified Table not found No table specified

Example

See how in this javascript example.

In this example I'm expecting for you to have run through the new row example. Check Game DB for the row ID and let's attempt to delete this row.

/* 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 = "<input type=text id=row_id placeholder=id><button onClick=submitRemove();>Delete</button><div id=Error></div>";
	       /* Insert the response into your access_token variable for later requests */
	       access_token = this.responseText;
	   }
	  }
	};
}
/* Function will be run on button click */
function submitRemove(){
    /* Collect the input fields values into variables */
    var row_id = document.getElementById("row_id").value;
    
     /* Create New XMLHttp Request */	
	var xhttp = new XMLHttpRequest();
	/* The URL with endpoint */
	var url = "https://iDev.Games/api/post/data/remove";
	
	/* 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);
	/* Set header for passing information across */
	xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
	/* Send request with data */
	xhttp.send("table=exampleTable&row_id="+row_id);
	
	xhttp.onreadystatechange = function() {
	  if (this.readyState == 4) {
	   if(this.responseText == "Success"){
	   	/* Clear div contents with id Response */
       	document.getElementById("Response").innerHTML = "";
	   	/* Insert response inside element with id Response */
	   	document.getElementById("Response").innerHTML = this.responseText;
	   } else {
	   	/* Insert response inside element with id Error */
	   	document.getElementById("Error").innerHTML = this.responseText;
	   }
	  }
	};
}

RETRIEVING DATA >

API DOCS v1.1

Saving Data

Introduction

Creating a New Row

data/add

Parameters

Responses

Example

Editing an Existing Row

data/edit

Parameters

Responses

Example

Removing a Row

data/remove

Parameters

Responses

Example