> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/xamarin/get-started/xamarin-ios/integrate-ios.md).

# Step 1: Integrate Apryse SDK for Xamarin.iOS

Integrate a free trial of Apryse Xamarin SDK into your Xamarin.iOS app effortlessly. Follow our guide for step-by-step instructions and enjoy unlimited trial usage with support from solution engineers

Welcome to Apryse. This guide will show you how to integrate a free trial of the Apryse Xamarin SDK into your Xamarin.iOS application. You can either integrate the Apryse packages automatically through the Nuget manager, or install them manually by downloading the SDK. Pick whichever option you prefer, but integrating with Nuget is the recommended approach. Your free trial includes unlimited trial usage and support from solution engineers.

{% tabs %}
{% tab title="Integrate with NuGet" %}

## Integrate With Nuget

## Prerequisites

* Latest version of Visual Studio

{% hint style="info" %}
**No trial license key required.**

The trial of Apryse Mobile SDK does not require a trial key. A commercial license key is required for use in a production environment. Please [contact sales](https://apryse.com/form/contact-sales) to purchase a commercial key or if you need any other license key assistance.
{% endhint %}

{% hint style="warning" %}
**Keep your license keys confidential.**

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).
{% endhint %}

## Integrate

To integrate Apryse libraries into one of your own projects, here are a few simple steps to prepare your Visual Studio project.

1. If you do not already have an existing application, create a new Visual Studio `Multiplatform` -> `Blank Native App` project called `myapp`:

![](https://653871032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgjsBtuYmcKhWOdM9VCg4%2Fuploads%2Fgit-blob-64c3671e620dfb4a71ac8698500fae5624032157%2F714f2bdbbcaaf0a69fe3ac0ecc09996729ac0b85-1814x1332.png?alt=media)

1. Open the NuGet package manager by right clicking on **Packages** > **Add Packages...**:

![](https://653871032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgjsBtuYmcKhWOdM9VCg4%2Fuploads%2Fgit-blob-d267105efb6586d28a5a8841b4f4664b10a158bb%2Fa471687b5872cd29609c101dd7079706e44dfc97-322x267.png?alt=media)

1. Search for `Apryse` and add these packages:

![](https://653871032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgjsBtuYmcKhWOdM9VCg4%2Fuploads%2Fgit-blob-396324844ae4cb4c73737bfde299680ab2c8d6fd%2F3c56f59ce8530d776f20d611dd133a75a7c71664-567x75.png?alt=media)

![](https://653871032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgjsBtuYmcKhWOdM9VCg4%2Fuploads%2Fgit-blob-b6d0ce99c8902a3967a49844da5a20ce2e5fcdd6%2F38fc24cac757906375d741c5358b111ea7808f3f-569x74.png?alt=media)

{% hint style="info" %}
Please note all of the required dependencies will also be installed.
{% endhint %}

## Next step

<a href="/xamarin/get-started/xamarin-ios/view-ios.md" class="button primary">View a document</a><a href="/xamarin/get-started/faq/add-license.md" class="button primary">Add an Apryse license key</a>
{% endtab %}

{% tab title="Integrate Manually" %}

## Manual Integration

## Prerequisites

* Latest version of Visual Studio

{% hint style="info" %}
**No trial license key required.**

The trial of Apryse Mobile SDK does not require a trial key. A commercial license key is required for use in a production environment. Please [contact sales](https://apryse.com/form/contact-sales) to purchase a commercial key or if you need any other license key assistance.
{% endhint %}

{% hint style="warning" %}
**Keep your license keys confidential.**

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).
{% endhint %}

First, download the SDK:

## Download

Download the SDK

[download Xamarin.Android.zip](https://pdftron.s3.amazonaws.com/downloads/PDFNetXamarin.Android.zip)

Download the SDK

[download Xamarin.iOS.zip](https://pdftron.s3.amazonaws.com/downloads/PDFNetXamarin.iOS.zip)

## Integrate

If you do not already have an existing application, create a new Visual Studio `Multiplatform App` project with `Blank Native App`.

1. Add the new NuGet source to where the Apryse for Xamarin.iOS download package's `lib/ios` folder is as described in [Adding Package Sources](https://docs.microsoft.com/en-us/visualstudio/mac/nuget-walkthrough#adding-package-sources).
2. Then right click your project and open the **Add** -> **Add Packages** window. Switch the source to the newly added source. You will see the packages:

![](https://653871032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgjsBtuYmcKhWOdM9VCg4%2Fuploads%2Fgit-blob-f7ae5257b529e1ed93a0a739841b260f275de2ed%2F35074750dbcf80bc3424f06584a0513ec1a1acba-820x543.png?alt=media)

1. Select `PDFTron.iOS` and click `Add Package`.
2. Select `PDFTron.iOS.Tools` and click `Add Package`.

{% hint style="info" %}
Please note all of the required dependencies will also be installed.
{% endhint %}

## Next step

<a href="/xamarin/get-started/xamarin-ios/view-ios.md" class="button primary">View a document</a><a href="/xamarin/get-started/faq/add-license.md" class="button primary">Add an Apryse license key</a>

## SDK overview

Apryse for Xamarin contains the following key files and folders:

| File/Folder Name                  | Description                                                                                   |
| --------------------------------- | --------------------------------------------------------------------------------------------- |
| Common                            | Folder containing Apryse Xamarin source code                                                  |
| custom (Xamarin.iOS package only) | Folder containing helper project to build `PDFNetHelper.framework`                            |
| lib                               | Folder containing the Apryse NuGet packages and the source files to the binding projects      |
| projectSrc                        | Folder containing Visual Studio solution files for Apryse Xamarin source code                 |
| samples                           | Folder containing the sample projects CompleteReader, PDFViewCtrl UI and MiscellaneousSamples |
| legal.txt                         | Legal and copyright information                                                               |
| License                           | Link to Apryse Software License agreement                                                     |
| {% endtab %}                      |                                                                                               |
| {% endtabs %}                     |                                                                                               |


---

# 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.apryse.com/xamarin/get-started/xamarin-ios/integrate-ios.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.
