Phoenix

Getting Started

Everything a newbie should know

Welcome to the Phoenix platform.  Here you will learn how to get started with Phoenix.

Creating a project

A "Project" within Phoenix separates the back-end of one application from another. Generally you should have separate projects per application, but if you have multiple applications (eg an iOS and an Android application) that reflect the same brand, these applications can share the same project as they most likely will want to share the same back end data.

To create a new project within Phoenix, complete the following steps:

  1. Login to the Dashboard at http://dashboard.phoenixplatform.com/.  If you don’t have an account, please Contact Us.
  2. On the Projects drop down, select "Create Project".
  3. Fill in the Project title (eg the name of your app) and set it to Active and click Save
  4. On the Project Detail screen, enable the modules that your Project requires.

Creating a user

A user account is required to access either the Phoenix Dashboard, or the Phoenix API’s.  Users can be humans or applications.  Human users log into Phoenix with a username and password, whereas Application Users access the Phoenix API with API credentials. Each application should have it's own set of Credentials so you can control access to your Project data.

To create a new user within Phoenix, complete the following steps:

  1. Inside the Dashboard, click on Settings and the “Users” option.
  2. Fill out the form and click "Save".
  3. You will then need to assign roles & permissions and generate API Credentials

Assigning Roles & Privileges

Users of Phoenix are restricted to a Role Based Access Control (RBAC) security policy.  Users must be assigned Role(s) and/or Privleges to gain authorisation to Phoenix API operations. To assign roles & privleges, follow these steps:

  1. Select a User that you want to manage
  2. Click on the Roles & Privileges tab
  3. Click Add
  4. Select the Role that you wish to add. You can only assign users a role that you have access to.
  5. Select the Provider, Company and Project that the Role should apply to. You can only assign the Role for
  6. Click Save.

Generating API Credentials

Application Users require API Credentials to authenticate to the Phoenix API’s.

  1. Select a User that you want to manage
  2. Click on the API Credentials
  3. Click 'New'
  4. Copy and paste the API Key and API Secret and store them in a safe place. These are required to call the Phoenix API's.

API Endpoints

Each Phoenix module exposes SOAP and WEB endpoints. Generally speaking:

  • SOAP endpoints are more suited for server-side integration
  • WEB endpoints are better suited to be called direct from your app

OAuth 2

The Phoenix API's support authentication via the OAuth 2 protocol. Currently the Resource Owner Password Credentials and Client Credentials grant type flows are supported.

iOS SDK

The Tigerspike Phoenix SDK (TSPhoenix) is an iOS SDK for Tigerspike Phoenix Platform. providing a path to success when building iPhone / iPad apps integrations with Phoenix Platform. The SDK allows you as a developer to interface with objective-level APIs and focus your time and energy on the UI

  • Native Objective-C APIs
  • Native Objective-C models, with 100% coverage of Phoenix server side models
  • Lightweight: TSPhoenix is a very thin layer built-on top of AFNetworking
  • OAuth2: log in, out, auth tokens, etc.
  • Install via Cocoapod
  • Install via GitHub

.Net Service Helper

The service helper provides a simple helper concept for consuming Phoenix abstracting away the core framework fundamentals in a simple and DRY manner whilst advocating best patterns and practices.