Welcome to the Gloebit Integration Guide for merchants and developers. This document will guide you through the simple steps from getting started and testing Gloebit's services, to going live on production when launching your application or game.
In order to integrate Gloebit's services, you need an OAuth key and secret for your application. These application credentials are what securely authenticate your application when it is making request to the Gloebit services, and are required for integration. There are two ways to obtain application credentials and get started.
This is the ideal way to get started and it will only take a few minutes to do the following:
Please see our Sandbox Tutorial for easy to follow instructions for the above steps.
Once finished, you will be ready to integrate and test using our sandbox.
Already have a Gloebit sandbox merchant account with an application you've tested? Great, we're excited that you've chosen to return to use Gloebit again.
There's no need to create a new Gloebit sandbox merchant account. From the Merchant Tools page on your existing Gloebit account, simply click the "add application" button to create a new application within your existing account. Each application has its own OAuth key and secret and can be configured separately. You can add as many applications as you need within your Gloebit merchant account.
When you are ready to go live, you have the same functionality from your merchant account on our production system so that you can manage all of your applications from one account.
We recommend that you follow the steps above to set up your own application; however, if you are so excited that you just can't wait even one more minute to integrate and test Gloebit's APIs, we have created a shortcut for you. Our sandbox system has a test application you can start using immediately. Thus, if you would like to skip right to testing integration, you may use the following credentials for the test application:
Test Application Credentials
Using the test application's credentials, you will be able to test most api calls and the user experience for your customers. You will not be able to adjust the api settings for the Test Application, nor will you be able to test any api calls which require any information beyond the key and secret from the Test Application api settings, such as are required by our Product Inventory Service.
When you decide to move forward with Gloebit, you will still need to follow the steps for setting up your own application in our sandbox and replace the Test Application credentials with those for your own application
Once you have obtained sandbox credentials for your application, you are ready to integrate with our sandbox environment. When integrating with the sandbox environment, make sure to use the sandbox URL endpoints and application credentials from an application created in the sandbox environment, not from our production environment.
Sandbox URL endpoints: https://sandbox.gloebit.com/<endpoint>
If you're integrating our digital currency with OpenSim, we've already done all of the work for you. See the details in our OpenSim section and sign up for beta access.
All of the Gloebit Service api calls require an access token which identifies your application and stores the authorization provided from a Gloebit user to your application to interact with the user's account via each service. Begin by integrating Authorization and obtaining access tokens to use with Gloebit services. Learn more about Gloebit Authorization.
Use the application OAuth key and secret you obtained from creating an application in our sandbox environment (or the Test Application credentials) when integrating Authorization.
Once you have integrated Authorization, you can integrate any or all of the other services which Gloebit provides. See each for more details:
Please see the following resources to aid in your integration of our services:
We are a big fan of open source tools. If, in your development, you create a tool which would be useful for our community of developers such as wrapping our calls in a new language, or designing a great front end to tie into our character system, and you are willing to make it available, please let us know. We will be happy to review it and provide it for general use.
Once you have obtained application sandbox credentials and integrated with sandbox API endpoints, you can fully test your application and all Gloebit merchant functionality. We recommend you fully configure and test your application in our sandbox before going live. After you go live, you are welcome to keep a sandbox version of your application tied to our sandbox environment for continued development and testing of new features. Our sandbox can become a useful component of your QA and release pipeline.
In order to test the sandbox api endpoints, you will not only need an application in the sandbox environment, but also consumer accounts created in the sandbox environment. This is done th exact same way as production accounts, except within our sandbox environment.
You should be able to test every aspect of your integration with our sandbox environment.
Our payment methods are sandboxed so you can perform extensive testing without being charged. Bitcoin does not have a sandbox environment, so we have disabled bitcoin in sandbox. Gloebits purchased in sandbox are not usable in production. They are just for testing.
Your sandbox application will earn gloebits from any transactions you test. You will be able to see these accrue in your balance and records from them in your transaction history. You will even be able to sell these gloebits from your Merchant Tools page. You will not be able withdraw profits from the sandbox as these are test gloebits, but you will be able to see the sales occur and accrue a USD balance.
All of the api settings for your application in our sandbox work identically to our production environment. Configure your application to get every reference and link to your application on our Gloebit site to look exactly how you would like. When you go live, we provide a mechanism to move all of these settings right to the production environment.
When you are approaching launch of your application, you will want to move your application from sandbox to production, or create a production version of your application tied to the Gloebit production environment. It is best to start this process before your launch date as there are a couple of reviews which must occur.
This is very similar to setting up your sandbox merchant account, but it is done on our production environment.
Please see our Production Tutorial for easy to follow instructions for the above steps.
Submit the merchant upgrade request for your production account early. When you signed up for a Sandbox account, you did not need to provide us any information in the signup form. When you sign up on production, you are required to fill out all of the information. We will need to review this and in some cases, may require some additional information to verify the data you have submitted. We recommend you do this well before the launch of your first application in case there are any delays. Until you have been approved, your applications may not be able to use balance and transact api functions and you will not be able to sell gloebits or cash out.
Set your OAuth Key Alias on production. If you are using an alias in your sandbox implementation to set your "r=<application>" url query argument when sending a user to us to purchase gloebits, then you should make sure the same alias is available on production. These aliases are unique across an environment, and grabbing one in sandbox does not necessarily mean it will be available on production. If it is not, find something available on both. Sorry for any inconvenience.
Test out transferring your application api settings. We provide you functionality to download and upload settings. Try downloading the settings from your sandbox application and uploading them to your production application. Make sure you have no problems. Restoring from a downloaded file will overwrite everything except the Gloebit Authorization Information section.
In the production version of your application, you must tie into the production endpoints with your production key and secret for you application
Switch all endpoints from https://sandbox.gloebit.com/<endpoint> to https://www.gloebit.com/<endpoint>. If you are using one of our APIs, then you need only tell the API to stop using the sandbox server, usually by clearing a SANDBOX constant in the module.
Find your application key and secret in the api settings for your production application and use those to replace the sandbox key and secret you used when you integrated.
If you set any permitted callback URI prefixes, you may want to verify that they are the same for production and sandbox. If so, copy them over manually. If not, enter the proper callback URI prefixes for the production version of your application.
If you have not already done so, in the api settings for your production application, toggle the "make application findable" option on in your application information. This will make it discoverable from our partner apps page so that we can drive some traffic to your application. There may be a delay before your application appears if there have been any recent changes to your application information in your api settings which we have not yet reviewed. Please contact us if your application does not appear, or if a delay might affect your launch.
If you have a question while integrating, please contact us and we will do our best to help. If you believe you have found a bug or a mistake in any of our documentation, then please alert us and we will fix and clarify the issue. If there is a feature you would like from our service, please let us know. We will let you know if there is a way to accomplish your goal within the current feature set, and we will factor requests into our roadmap for future development.
If you have a question while integrating, please contact us and we will do our best to help. If you believe you have found a bug or a mistake in any of our documentation, then please alert us and we will fix and clarify the issue. If there is a feature you would like from our service, please let us know. We will let you know if there is a way to accomplish your goal within the current feature set, and well factor requests into our roadmap for future development.
