Gloebit Developer Logo

Blog

Sandbox

Main Site

Gloebit Application Configuration Instructions

The Application Configuration page is where you provide Gloebit the information we need for your application. You access your applications' configuration pages from your Gloebit Merchant Tools page, in its Applications box on the top-left. You also add new applications here.

If you are adding your first application, click on the Add an Application button. You will be taken to the application configuration page for your first app.

To edit the information for one of your existing applications (or to delete the application), click on the Configure button next to the name of the application you want to configure.

Application Information Fields

This section contains general settings for how your application is represented on the Gloebit site.

Name

The name you want Gloebit to use for your application. Gloebit will display it in the following locations on the Gloebit website:

Description

A short description of your application. Gloebit will display it in the following locations on the Gloebit website:

Publisher

The name of your application's publisher or a parent company with many applications. This field is useful for associating many applications with either a single publisher or a parent company. Gloebit will display it in the following locations on the Gloebit website:

Logo

A logo image for your application. Gloebit will display it in the following locations on the Gloebit website:

Image Requirements

Return-to Text

Special text for a trackback link back to your application's webpages (or homepage). If left blank, Gloebit will use "Return to" with the name of your application for the link. (Adding a return-to query arg in the request or having a default URI in the next field is necessary to display trackback links.) Gloebit will display it in the following locations on the Gloebit website:

Default Return-to URI

The URI to redirect users to when they choose to return to your application's webpages (or homepage). This URI is used for trackback links unless your application's HTTP requests include a URI in the return-to query arg, which will override this URI. (If this field is left blank and your requests do not include return-to URIs, then Gloebit will omit the trackback links.) Gloebit will use this URI for links to your application webpages in the following locations on the Gloebit website:

Make Application Findable

Controls whether your application is discoverable via the Partner Applications page on the Gloebit website. Checking this will make your application visible on the Partner Applications page.

Processing Delay

On the production server, there may be a delay after making changes to this checkbox while we review any updates. On the sandbox server, changes are immediate and checking it on sandbox will make your application visible there.

Gloebit Authorization Information Fields

This section contains settings used by your application and Gloebit to authorize your application's access to customer accounts.

OAuth Key

The Gloebit-assigned uuid for your application. Your application uses this key to identify itself during authorization. Note that this key is included in certain URLs and thus visible to users. Nevertheless, you should not share this key with anyone. This field is read-only.

OAuth Secret

A secret string to confirming your application's key. Your application uses this key to verify its identity during the second step of two-step authorization. Gloebit initially populates it with a uuid. You may change the string to one of your choosing if you prefer.

Keeping this string a secret is of utmost importance. Never share it with anyone and do not hard code it into an application where it could be discovered by a user.

OAuth Key Aliases

Alias strings for your application's OAuth Key. You can define a aliases to use in URLs instead of the OAuth Key. Friendly, readable aliases can result in tidier URLs in the user's URL bars. Your application can use an alias in place of the key in the 'r' query argument for requests to Gloebit.

Aliases are unique across all of Gloebit. If you get an error when trying to create one, try another. We recommend something specific to your application name to reduce conflict chances.

We recommend using only alphanumeric characters, hyphens, and underscores in aliases. You can use other characters, such as spaces; however they will be encoded and less readable when placed into URLs.

To add an alias, enter it in the "Add Another" text field and then press enter or click the SAVE button at the bottom of the page.

Callback URI Prefixes

Validation strings to match against URIs for your application. These are optional, but recommended, security measure to guarantee that your users are returned to your application's webpages and helps prevent cross-site forgeries. For any URI associated with your Gloebit key (via HTTP request or from within the system via this configuration), Gloebit will check it against these prefixes before using it. A mismatching URI in an HTTP request will result in Gloebit responding with an invalid request. Also, Gloebit will not use your Default Return-To URI if it does not match a prefix.

We recommend you provide URI prefixes for your application. Here are further suggestions:

Allow Implicit OAuth2

Controls whether to allow implicit OAuth2 authorization for your application. Implicit authorization is a single-step authorization flow that is less secure but can be sufficient for trusted, server-less applications. The setting is disabled by default but you can enable it if your application will use the OAuth2 implicit authorization flow.

Product Descriptions

This section lets you define products for use with the Product Inventory Service and Product Parameters of the Digital Currency Service, if you choose to use them.

Name

The name of the product or entitlement. Gloebit uses this name to identify the product when using the Product Inventory Service and Product Parameters of the Digital Currency Service. The following are important considerations for product names:

Available

Indicates if product is avilable for purchase. Clearing the check makes the product unavailable for purchase but keeps the product in your application's database in case you wish to make it available later.

Note that copies of the product already in user's and character's inventories are not affected by making a product unavailable. The inventories will retain the products until you consume or remove them.

Price

The price in gloebits for the product. Gloebit charges the user this price per product when using the Product Parameters of the Digital Currency Service.

No Inventory Limit

Indicates whether to have a limit on number of products in an inventory. By default, there is no inventory limit for a product. Clearing this will allow you to enter a per-inventory limit for the product.

Per-Inventory Limit

The upper limit for product quantity in a user or character inventory when purchasing or granting the product. If the inventory is at (or above) this limit, the grant or purchase transaction will fail. Further details:

Can be Granted/Set

Indicates whether your application would like to grant the product or set product inventories outside of the Digital Currency Service. By default this is off. Turning it on enables additional functionality in the Product Inventory Service (i.e. non-transaction endpoints).

Important: If your application is using implicit OAuth2 authorization, enabling this feature may allow a user to mimic your application and grant or set products.

Add Product

To add a product, fill in the fields under Add Product, and then press enter or click SAVE at the bottom of the form.

Characters Settings

If your application is using Gloebit's Character Service, this section provides a couple means for controlling the service.

Allow Editing Characters

Indicates whether your application is allowed to edit character details after creation. If this checkbox is cleared, Gloebit will not allow editing any character details. By default it is cleared.

If your character parameters do not change (such as race=elf; sex=f; etc), then this is a good way to ensure your application doesn't accidentally make a change.

If you are storing more complex details such as experience and level, you may want to allow editing, or you may prefer to keep the character non-editable and storing those details as character inventory parameters.

Allow Editing Character Names

Indicates whether your application is allowed to edit character names after creation. If this checkbox is cleared, Gloebit will not allow editing character names. By default it is cleared.

DELETE, CANCEL, and SAVE Buttons

These big, blue buttons submit the configuration form and update Gloebit. Clicking on any will return you to your Merchant Tools page.

DELETE

Clicking on DELETE will permanently remove this application from Gloebit.

CANCEL

Clicking on CANCEL will discard any configuration changes.

SAVE

Clicking on SAVE will commit your configuration changes (including adding new aliases, prefixes, and products) to Gloebit.

Backups Buttons

These buttons allow you to save a copy of all settings on your local drive and restore them from a JSON file.