Documentation and Sandbox
Try our Sandbox now!! Get instructions here
We are using Symfony Framework as foundation for our API over PHP, but there are so much more technologies we are using while developing your gameboard.
|Database ORM||Doctrine 2 ORM|
|API Authentication||OAuth 2.0 (Same as Facebook, Google & Twitter)|
|API Documentation||Built-in in our platform|
|Translations||Yes, currently we support english and spanish.|
|Messaging||Firebase messaging (supported by Google)|
|SSL||Yes, with Let’s encrypt.|
Our servers are running over Digital Ocean technology into a Ubuntu 16.04 LTS for both, application and database server.
|GameBoard Frontend user||https://gameboard.me (Coming soon)|
Using our Sandbox
If you want to use the API documentation sandbox you need to get an access token to authenticate into Gameboard Platform.
Go to, https://gameboard.space, and click on Get Access Token button, it will prompt you to enter username (demo) and password (demo).
If you login is success, then will ask you to grant access to your personal data (It is OAuth 2.0 working on grant or deny access).
If everything is alright, then you will see the response object, something like this:
Copy the access_token key, and paste it on https://gameboard.space/api/doc page (It will ask you for the same demo account credentials: demo, demo).
You need to paste your access_token in the Token TextBox, and click save button.
And here we go, now, you have access to our (Not finished yet) API sandbox.
We hope you’ll enjoy with us gaming and growing.
Learn the terms
Is the successor to OAuth, an open authentication tool that allows users to share private resources without giving external parties or programs access to all of their identification data. OAuth 2.0 represents a revision of the original OAuth created in 2006 and contrasts with other similar authentication tools.
OAuth works by using authentication tokens, which act as pointers to a resource and provide parameters for sharing, such as a limited time window. This way, the user can give third parties access to certain features and functions in a program without giving access to everything stored therein, including personal data. This is similar to an authenticator called OpenID, but the two protocols are somewhat different. Whereas OAuth authorize third parties to use some of a user’s protected resources, OpenID is more focused on authorizing access to their identity.
One example that is often used to explain OAuth 2.0 and related versions is that the authenticator uses a string as a valet key for access to a particular item. The criticism here is that just like a key, a hacker could obtain the token and gain unauthorized access. Although current development of OAuth 2.0 promote widespread use through compatibility with Facebook and other platforms, some critics are concerned that this protocol could be a liability for overall network security depending on implementation.
Object-relational mapping (ORM) is a mechanism that makes it possible to address, access and manipulate objects without having to consider how those objects relate to their data sources. ORM lets programmers maintain a consistent view of objects over time, even as the sources that deliver them, the sinks that receive them and the applications that access them change.
Based on abstraction, ORM manages the mapping details between a set of objects and underlying relational databases, XML repositories or other data sources and sinks, while simultaneously hiding the often changing details of related interfaces from developers and the code they create.
ORM hides and encapsulates change in the data source itself, so that when data sources or their APIs change, only ORM needs to change to keep up—not the applications that use ORM to insulate themselves from this kind of effort. This capacity lets developers take advantage of new classes as they become available and also makes it easy to extend ORM-based applications. In many cases, ORM changes can incorporate new technology and capability without requiring changes to the code for related applications.
SSL (pronounced as separate letters) is short for Secure Sockets Layer.
Secure Sockets Layer (SSL) is a protocol developed by Netscape for transmitting private documents via the Internet. SSL uses a cryptographic system that uses two keys to encrypt data − a public key known to everyone and a private or secret key known only to the recipient of the message.
Application program interface (API) is a set of routines, protocols, and tools for building software applications. An API specifies how software components should interact. Additionally, APIs are used when programming graphical user interface (GUI) components. A good API makes it easier to develop a program by providing all the building blocks. A programmer then puts the blocks together.
Also referred to as a RESTful web service — is based on representational state transfer (REST) technology, an architectural style and approach to communications often used in web services development.
REST technology is generally preferred to the more robust Simple Object Access Protocol (SOAP) technology because REST leverages less bandwidth, making it more suitable for internet usage. An API for a website is code that allows two software programs to communicate with each other. The API spells out the proper way for a developer to write a program requesting services from an operating system or other application.