Mobile SDK allows you to create mobile apps over the CARTO platform.

API Keys

Registering Mobile App

The following procedure describes how to register mobile apps under your account settings. While the number of mobile apps is unlimited, application quota consumption rules are enforced based on your account plan. Contact us if you have questions about your mobile account options.

  1. Access your Account settings from the CARTO Dashboard

    Access mobile apps from API keys

    Your profile information appears.

  2. Click API keys

    The API key page opens, displaying options for CARTO or Mobile Apps.

  3. Click Mobile apps to add mobile applications to your account

    Note: If this option is not visible from your account settings, contact us to ensure that Mobile SDK features are enabled for your account.

    No registered mobile apps

  4. Click NEW APPLICATION

    The new application settings appear.

  5. Enter options for the mobile application

    New mobile app settings

    The following mobile application settings are available:

    Mobile Application Settings Description
    App icon Select an icon to represent your mobile application in your account
    Name An informative name of the mobile application in your account
    Description A description about the mobile application in your account
    Platform Identifies the type of mobile app platform. Some options may not be available, based on your account plan

    Note: Once a mobile application is saved, you cannot edit the Platform setting. As an alternative, you can delete the application and recreate it with new settings.

    Tip: When you select a Platform, the Application ID displays more details about what identifiers, or packages, are required.

    Platform App ID hint
    Application ID The identification of the mobile app in the App store that is required for development with the Mobile SDK.

    The following application ids identify the Platform selected:

    - Android: package from the AndroidManifest.xml file or applicationId in build.gradle

    - iOS: Bundle Identifier. You can find it in the project properties in Xcode

    - Xamarin Android: package from the AndroidManifest.xml file

    - Xamarin iOS: Bundle Identifier from the project Info.plist

    - Windows Phone (UWP): UUID from the Windows package.appmanifest
    App type Identifies the type of mobile application, which are subject to different quota limitations

    - Open: This app type is open to the public and is available as free download in public app stores

    - Private: Available for Enterprise accounts only, allows organizations to publish their apps internally and have paid app use cases.
  6. Click SAVE CHANGES

    The Mobile apps page refreshes, displaying the added mobile application and the features enabled.

Access your API Key

Once your mobile apps are registered for your account, you can retrieve the API Key for each application. This is useful when you need to copy and paste the API Key for mobile development.

  1. From the Mobile apps section of your API Keys, click a mobile application name

    Registered mobile apps

    The application settings appear, and include the license key and amount of quota for the application.

  2. Copy the API Key from the License key section

    The following example displays the API Keys section for a selected mobile application. Note, the API Key in the example image is blurred out for privacy.

    Example of mobile app settings

  3. Click the back navigation arrow, located next to the app name, to return Mobile apps section of your API Keys

API Key Rules

Mobile App API Keys cannot be regenerated manually, but are automatically regenerated in the following scenarios.

  • If you upgrade your account plan that includes additional mobile features, the Mobile apps license key is automatically regenerated

  • If you change the App type the Mobile apps license key is regenerated

You will receive a notification when mobile api keys are regenerated.

Deleting an App

Once a mobile application is saved, you cannot edit the Platform setting. As an alternative, you can delete the application and recreate it with new settings.

  1. From the Mobile apps section of your API Keys, click a mobile application name

    The application settings appear, and include the license key and amount of quota for the application.

  2. Click Delete this application from the bottom of the app settings

    Delete mobile app

  3. Click the back navigation arrow, located next to the app name, to return Mobile apps section of your API Keys