Getting Started with Flagship

How to start with Flagship

Welcome to Flagship!

The following steps will help you get Flagship up and running with any application, website, or connected device.

Flagship step by step

1. Install a Flagship SDK or implement the Decision API

Whether you're implementing Flagship directly via the Decision API or using one of our available SDKs, you'll need to have your environmentId handy to get set up.

Decision API or SDK: which implementation is right for you? ⟶

To find your environmentId:

  1. Log into your account
  2. Click on the Quickstart & Integration menu in the sidebar
  3. Click the Integration tab

Screen recording of how to navigate to Integration to find `environmentId`Screen recording of how to navigate to Integration to find `environmentId`

2. Set up your flags

Whether you want to run an experiment, personalize, toggle, or roll out a feature, you can do it all with Flagship!

Once you know what part of your app/website you want to flag, there are three types of flags to choose from:

  • Boolean
  • String
  • Integer

Each type allows a different level of flexibility over its configuration in Flagship — so choose wisely, sailor!

3. Set up your KPIs

Check with your Product Manager or business stakeholders to decide what KPIs to track. If your User/Job Stories and tasks are properly documented, you will likely find all the information needed there.

The purpose of linking flags to a business KPI is twofold:

  • Show stakeholders the impact of your development on the end-users' experience
  • Demonstrate benefits via either increasing ROI or avoiding a loss of income

4. Create your first campaign on the platform

Whether you want to progressively deploy a new feature, add an on-off switch to a feature, run an experiment, or personalize your product experience, you’ll need to make sure it's well configured inside the platform.

If you're inviting team members to your account, keep in mind that users can have different roles in each environment (Preprod or Prod), so make sure you add your teammates to the correct group in each account environment.

📘

Additional resources

  • For more information on how to create campaigns, follow the link here.
  • To learn more about access rights and user management, follow the link here.

Flagship integration

You can integrate Flagship with your application through the Decision API or using one of our available SDKs. The method you choose will depend on your particular needs.

The Decision API is the engine that powers Flagship. This method lets you integrate applications in any programming language and gives you full control over implementation. You can view the Decision API documentation for each version here:

Our SDKs are client libraries that provide prebuilt methods for interacting with the Decision API, saving you setup time at the expense of custom configuration. Additionally, local variation assignment via bucketing is only available using an SDK that supports it. Find the documentation for the latest version of each SDK below:

❗️

Important

Regardless of the method you choose, make sure you always set up a default value for your flags, also called a fallback, in the following cases:

  • No internet connection
  • User hasn’t yet been assigned to a variation
  • Panic mode is activated

What's next?

You’re almost ready to go!

Next step is creating your first campaign, setting up your flags, choosing your targeting keys, and pushing everything to prod.

The best part? You can manage your flags in Flagship without performing a new merge request or having to push your application to the store again!

Are you as excited by this new adventure as we are? Let us know how it goes!

Product News

👍

Release notes

For the latest product news, you can follow our public release notes here.


Did this page help you?