Installation

Before starting to develop your application with the Maps SDK, you'll need to configure your credentials and add the SDK as a dependency.

Configure credentials

Note

If you plan to install the SDK via direct download, you do not need to configure a secret token. You will still need to configure a public token.

Before installing the SDK, you will need to gather the appropriate credentials. The SDK requires two pieces of sensitive information from your Mapbox account. If you don't have a Mapbox account: sign up and navigate to your Account page. You'll need:

  • A public access token: From your account's tokens page, you can either copy your default public token or click the Create a token button to create a new public token.
  • A secret access token with the Downloads:Read scope.
    1. From your account's tokens page, click the Create a token button.
    2. From the token creation page, give your token a name and make sure the box next to the Downloads:Read scope is checked.
    3. Click the Create token button at the bottom of the page to create your token.
    4. The token you've created is a secret token, which means you will only have one opportunity to copy it somewhere secure.

You should not expose these access tokens in publicly-accessible source code where unauthorized users might find them. Instead, you should store them somewhere safe on your computer and make sure they're only added when your app is compiled. Once this configuration step has been completed, you will be able to reference your credentials in other parts of your app.

Configure your secret token

Your secret token enables you to download the SDK directly from Mapbox. To use your secret token, you will need to store it in a .netrc file in your home directory (not your project folder). This approach helps avoid accidentally exposing your secret token by keeping it out of your application's source code. Depending on your environment, you may have this file already, so check first before creating a new one.

The .netrc file is a plain text file that is used in certain development environments to store credentials used to access remote servers. The login should always be mapbox. It should not be your personal username used to create the secret token. To set up the credentials required to download the SDK, add the following entry to your .netrc file:

machine api.mapbox.com
login mapbox
password YOUR_SECRET_MAPBOX_ACCESS_TOKEN

Configure your public token

To configure your public access token, open your project's Info.plist file and add a MBXAccessToken key whose value is your public access token.

If you ever need to rotate your access token, you will need to update the token value in your Info.plist file accordingly.

guide
Access token best practices

Learn how to keep access tokens private in mobile apps.

Add the dependency

Mapbox provides the Maps SDK via Swift Package Manager, CocoaPods and direct download. You can choose whichever you prefer.

Mapbox Maps can be consumed via Swift Package Manager (SPM). To add the Mapbox Maps SDK with SPM, you will need to configure your environment to download it from Mapbox. This requires a Mapbox access token with the Downloads:Read scope. In a previous step, you added this token to your .netrc file.

  1. Go to the project file and select swift packages. Then press the "+" button to add a new package.
  2. Insert https://github.com/mapbox/mapbox-maps-ios.git as the URL, press Enter to pull in the package, and click Next.
  3. To install a specific version, set the Dependency Rule field to one of the version-based options and insert the desired version. The latest stable version of the Maps SDK is 10.6.0.
  4. At this point, everything should be fetched and loaded up. Select the "MapboxMaps" library and then press finish.
  5. In your code, you can now import MapboxMaps as well as any of the other packages that were downloaded as dependencies.

Notes

  • If you need to update your packages, you can click on File > Swift Packages > Update To Latest Package Versions
  • Sometimes, artifacts cannot be resolved or errors can occur, in this case select File > Swift Packages > Reset Package Cache
  • If your Xcode crashes, delete your derived data folder

Add a map

Note

The Maps SDK can be used with SwiftUI by wrapping it in a View conforming to UIViewRepresentable. Please refer to the SwiftUI documentation for more details on how to use UIViewRepresentable.

Insert the following code snippets into your ViewController.

import UIKit
import MapboxMaps
class ViewController: UIViewController {
internal var mapView: MapView!
override public func viewDidLoad() {
super.viewDidLoad()
let myResourceOptions = ResourceOptions(accessToken: "your_public_access_token")
let myMapInitOptions = MapInitOptions(resourceOptions: myResourceOptions)
mapView = MapView(frame: view.bounds, mapInitOptions: myMapInitOptions)
mapView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
self.view.addSubview(mapView)
}
}

Run your application and you will see a map on the screen.

Running into problems installing? Read more about common installation issues in our troubleshooting guide.