> For the complete documentation index, see [llms.txt](https://docs.mapsindoors.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mapsindoors.com/sdks-and-frameworks/ios/getting-started/integrating-mapsindoors-into-your-own-app.md).

# Integrating MapsIndoors into your own App

The **MapsIndoors Template** is a downloadable starting point for you to integrate basic usage of MapsIndoors, containing search and directions functionalities, into your existing app. If you just want to get started with a simple solution with no customisation, this should fulfil your needs. Going through this guide will also teach you some principles on how MapsIndoors interacts with an app, and is a natural next step after the "Getting Started" guides.

If you need more customisation you can implementing your own solution using the documentation found on this site, or modify this code as needed.

**MapsIndoors Template** is provided as is, and can be integrated into your existing app. If you need further features, or want to customize existing ones, you're free to modify this one to your needs. However, MapsPeople offers no support or responsibility for changes made.

### Prerequisites​ <a href="#prerequisites" id="prerequisites"></a>

Before you get started, you need to get the API keys needed. This process is the same for both platforms.

#### Get Your Google Maps API key​ <a href="#get-your-google-maps-api-key" id="get-your-google-maps-api-key"></a>

First, you need to [setup at a new project in the Google Cloud Console](https://developers.google.com/maps/gmp-get-started), just like you did in the ["Getting Started"](https://docs.mapsindoors.com/getting-started/ios/v4/getting-started/ios) guide (**Please note:** You are going to need a Google Billing Account for this step, so go ahead and [create one](https://cloud.google.com/billing/docs/how-to/manage-billing-account#create_a_new_billing_account) if you haven't already). When the project is created, the following APIs and the specific SDK you plan to use must be enabled from the [Maps API Library Page](https://console.cloud.google.com/apis/library?filter=category:maps).

* Google Maps Distance Matrix API
* Google Maps Directions API
* Google Places API Web Service
* Maps SDK for Android/iOS

When the above 3 APIs and the relevant SDK are enabled, you can retrieve the API key from the [Credentials page](https://console.cloud.google.com/project/_/apiui/credential). On the Credentials page, click *Create credentials* > *API key*.

#### Mapbox API Key​ <a href="#mapbox-api-key" id="mapbox-api-key"></a>

* Follow the guide here [Getting Started](https://docs.mapbox.com/help/getting-started/) to retrieve API Key

#### Get Your MapsIndoors API key[​](https://docs.mapsindoors.com/getting-started/ios/v4/mapsindoors-template#get-your-mapsindoors-api-key) <a href="#get-your-mapsindoors-api-key" id="get-your-mapsindoors-api-key"></a>

If you are not a customer yet, you can use this demo MapsIndoors API key `d876ff0e60bb430b8fabb145` to follow this guide, or you can [contact MapsPeople](https://resources.mapspeople.com/contact-us) to get your building drawings processed and hosted by us to receive a unique API key. For the purpose of this guide, both methods will work.

#### Getting Started <a href="#getting-started" id="getting-started"></a>

{% hint style="info" %}
This app is designed to be displayed in Portrait Mode. While it will work in Landscape Mode, some UI elements may look distorted or out-of-place.
{% endhint %}

This app provides an example of how to use the MapsIndoors SDK in SwiftUI.

* Download or clone the pre-made project from GitHub: [MapsIndoorsTemplate-iOS](https://github.com/MapsPeople/MapsIndoorsTemplate-iOS-v4)
* From the terminal, in the path you cloned the repository to, run `pod install`
* Open the file `xxxxx.xcworkspace` in Xcode, or your editor of choice
* Add your MapsIndoors API key and your Map Engine API key

#### Using the Functionality in your Own App​ <a href="#using-the-functionality-in-your-own-app" id="using-the-functionality-in-your-own-app"></a>

This project is specifically built so you can easily re-use this functionality in your own application, without further issue.

* This app serves as a starting point.
* It was built with SwiftUI
* You can extend this to fit your needs.

{% hint style="warning" %}
Due to [a bug in CocoaPods](https://github.com/CocoaPods/CocoaPods/issues/7155) it is necessary to include the `post_install` hook in your Podfile described in the [PodFile post\_install](https://github.com/MapsIndoors/MapsIndoorsIOS/wiki/Podfile-post_install-v4) wiki.
{% endhint %}

#### The Final Result​ <a href="#the-final-result" id="the-final-result"></a>

<figure><img src="/files/qzBTJd9cL08w8UTXtkFs" alt=""><figcaption></figcaption></figure>

### Summary​ <a href="#summary" id="summary"></a>

Congratulations! You now have a functioning map in your own app, with the ability to both search for Locations and generate directions! If you want more advanced features, check out [further documentation](https://docs.mapsindoors.com/display-rules/), or modify the existing code from this tutorial to suit your needs!


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mapsindoors.com/sdks-and-frameworks/ios/getting-started/integrating-mapsindoors-into-your-own-app.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
