5 Minute Guide

We are pleased to welcome you on our 5 Min Guide for Admin panel! Here you will find the description of the registration and signing in processes and guides on how to create an application in the Admin panel and how to run a test app on your computer. We hope it will be helpful for you!

1. Register on the Admin panel

To get started with the registration process, please visit https://admin.quickblox.com Website and click on “Register” at the top of the page or just follow the link: https://admin.quickblox.com/register.

On the registration page you need to enter your full name, email, login, password, repeat your password, phone and website.

Notes:

1. Fields that marked with * are required, others are optional.
2. If unacceptable characters were entered in the field, you wont be able to sing up and the message “Bad format” will be shown near this field.

After this you have to accept the Terms and Conditions of QuickBlox otherwise you wont be able to sign up. To read the Terms and Conditions just follow the link next to the check box.

When you do all these, click on the button Sign Me Up at the bottom of the page. Then a confirmation letter will be sent to your email. You can confirm your registration by following the link in the letter.

Congratulations! You've been registered!

2. Sign In to the Admin panel

To be able to sign in to the Admin panel you need to register first. To get the information on how to get registered on the Admin Module, please, see the Registration on the Admin panel section.

To sign in, please, follow the link https://admin.quickblox.com/signin, enter your Login and Password and click on the Sign In Now button.

If you forgot your Username or Password or entered them incorrectly the system will not allow you to sign in and a notification will be shown above.

You have to enter correct data or click on the "Can't sign in? Did you forget your username or password?" link in the notification area for help. If you click on the link, you will be asked to enter your email address to send password reset instructions to it. When your email is entered just click on the "Send me reset instructions" button and a letter with the request to obtain your new password will be sent to your email.

To obtain your new password just click on the link in the letter and a letter with your new password will be sent to your email.

After your Login and Password are entered correctly, you will be signed in the system.

3. Create an app in the Admin panel

To be able to create your own app in the Admin panel, you need to sign in the system first. To get the information on how to sign in the Admin panel, please see the Sign In to the Admin panel section.

After you've signed in, you will see the main page where you need to find the "Add new application" button and click on it.

Then you will have to fill in the "Add new application" form. Here you need to enter the information about the title of your app, its website, type (game, fun, office, productivity and other are possible) and description. Note: Fields "Title" and "Type" are requested others are optional.

After all the information are entered just click on the button "Add" in the bottom of this form and the app, that you've created, will be shown in the list of your apps.

To delete an app from the list just click on the garbage can near this app. If you want to view the information about an app or edit them you should click on its name. Besides the information that you've entered earlier there will be shown the application id, your account id, authorization key and authorization secret. These are important values - you will need them for your client application.

Note: On these two pages you also get the access to available services: Location, Users, Message, Content, Content, Ratings, Chat.

4. Run the test application named SuperSample

4.1. Download the SuperSample app

SuperSample is demo application that is created to demonstrate how to use QuickBlox services. It is available on github.com as open source project. To download the SuperSample from github, please, follow the link: https://github.com/QuickBlox/SuperSample-ios and click on the "ZIP" button in the top of the page.

4.2. Open SuperSample through the Xcode

To open the SuperSample on your computer you have to unpack ZIP archive that you've downloaded and open SuperSample.xcodeproj file in it. When file is opened, you will see the source code of the SuperSample application. Note: The Xcode must be installed on your computer.

4.3. Connect to the QuickBlox.framework

To get the information on how to connect to the QuickBlox.framework, please, refer to the IOS-how-to-connect-Quickblox-framework page.

4.4. Replace the data about your application

Now you have to replace the data about your app in the SuperSample with the data about your app in the Admin panel. To do this you need to open the SuperSample.xcodeproj file and in the left of the window refer to the SuperSample -> Classes -> Definitions and view the QBConsts.h file. Here you will find the data that you want to change.

Then you should open the Admin panel and view the information about the app that you've earlier created. Here you will find the correct data. You have to replace the following data:

appID = Application id;
ownerID = Account owner id;
authkey = Authorization key;
authSecret = Authorization secret.

4.5. Run the test application

To test the app you should click on the "Run" button at the top left corner of the window and wait a few seconds. App will be compiled and installed on the Simulator. If you do everything right, you will see the screen of the app, otherwise the alert errors will appear.

Congrats! Now you can play with your own SuperSample! All that you left to do is do the same for your own client app!

Enjoy it!