API Documentation - GoEverywhere/Go-Everywhere GitHub Wiki

Go Everywhere does not have an official API url. However, when developing, you may need raw data. This is a list to explain the output of all of our files that will output raw data, and the format that they do it in.

/explore/index.php

This file will echo all (ALL) the shared projects as either HTML or XML. The HTML portion is specifically for the desktop website, however you can still use it as an API if you want (although it will be highly ineffective). To access the XML portion, simply include the URL with the GET variable ‘type’, with the value ‘xml’ (ex. http://localhost/Go-Everywhere/explore/index.php?type=xml ). The xml document is in the format below: ```xml ``` An example XML file output is: ```xml ```

/actions/login.php

This file will log the user in via POST, and is primarily used for logging the user into the desktop site. However, you may need to verify the user's password.

Because of security, we are not going to supply a GET request script, however you can still verify a user's credentials. If you access the script with the GET variable returnonly , and the value true (ex. http://localhost/Go-Everywhere/actions/login.php?returnonly=true ), it will not redirect the user to a different page. It will, instead, echo back one of two things.

If the credentials are true, then the script will return:

true

If the credentials are false, then the script will return:

false?ERROR_MESSAGES

Each error message is separated by a comma (,). This is so that you can display a more friendly response. For example, when given back this false response, first split the string into two parts with the question mark (?). Then, take the second element from the split array and split that with the comma (,). The error messages are simple, one word commands:

noaccounts

There are no accounts with the given username/password (most likely an incorrect password).

multipleaccounts

There are multiple accounts for that specific username. Tell the user to contact an admin ASAP.

noscratch

The user did not verify their Scratch account. Due to security issues, the user must have linked their Scratch account. This is most likely related to an incomplete registration. You may want to tell the user to contact an admin to get this resolved.

banned:TIME

The user is banned, until TIME. TIME and the banned message are separated by the colon ( : ). TIME can either be in the format mm/dd/yyyy, or the word “forever”, so you can just display the contents of TIME as it is pretty friendly already.

/actions/project_info.php

This file will echo out an XML file, containing project info with the GET variable “id” (ex. http://localhost/Go-Everywhere/actions/project_info.php?id=1 ). The format of the XML output is simple. Here is a sample XML output: ```xml ``` “user” is the project owner. “id” is the id of the project. “date” is the date that the project was shared/uploaded. “title” is the title of the project. “description” is the description of the project.