Before you get started with Roam’s SDK, you’ll need to create a project. Your project will allow you to access the dashboard features, manage your usage and access your unique SDK key to start integrating into your app.

Sign-up

First, create your free account by providing your name, email and company name. You will receive a six-digit confirmation code via the email provided. Once you enter this confirmation code in the dashboard, you’re ready to start creating your first project!

Blank Project or Ignite Project?

There are two ways you can create a project via our dashboard, a Blank Project or an Ignite Project. Creating a Blank project is for developers who want to integrate Roam.ai's SDK and APIs into an existing application.

If you're a product manager or anyone who wants to try out Roam.ai's SDK and APIs without any coding, check out our guide on how to create an Ignite demo app guide.

How to create a Blank Project

If you’re interested in integrating Roam’s location SDK into your iOS or Android app, you’ll need to create a Blank Project. Setting up a project will create your SDK key (Publishable Key), which is the unique identifier that allows you to initialize and authenticate the SDK into your app.

In addition to creating your project, the process will walk you through how to integrate Roam’s SDK depending on your platform.

Take a look below for the step-by-step guide:

  1. Choose your project name: This is something you can easily identify your project by, usually this is the name of your app.

2. Choose the platform that you will use and your integration method:

3. Register your application: To do this, you need to enter your Bundle ID (Android app) or Package Name (iOS app). This is an ID that uniquely identifies your application.

Important: Make sure you enter the exact application package name or ID.



Integrate the SDK


You’ve now created a project! You can choose to follow our integration steps or start integrating at a later stage. You can start testing Roam’s location SDK in your app with our free plan which gives you 10,000 free location updates.  

To find out more about integration, check out our quickstart documentation for iOS or Android.