Software Integration Policy

Pointr offers two software integration programs, depending on your License Agreement and desired level of support.

Standard Integration Program

Applicable when you acquire a Standard/Priority Pointr License for using the Pointr Mobile/Web SDK. 

Scope

  • Includes only “out-of-the-box” Pointr features and functionalities

  • Excludes custom integration support.

Support Sessions

  • Technical Review: One session (1 hour) to review any technical issues with Pointr developers.

  • Final Verification: One session (1 hour) to verify Standard Integration completion and allow developers to ask questions about implementing “out-of-the-box” functionality.

 

Hands-on Integration Program

Applicable when you acquire the Hands-On Software Integration Package in addition to your Standard/Priority Pointr License.

Scope

  • Supports integrating custom functionality into Pointr Map Widget components, including but not limited to changing the general behavior of the widget.

  • Pointr developers act as mentors, providing solution designs and technical consultancy; they will not perform actual implementation.

  • All customization or 3rd-party integration requests must be submitted to the Pointr Technical Project Manager and contractually signed-off prior to sessions.

Support Sessions

  • Technical Review: Two sessions (1 hour each) to review any technical issues with Pointr developers.

  • Custom Functionality Assistance: Two sessions (1 hour each) to get guidance on implementing custom functionality outside the Standard Integration.

  • Final Verification: One session (1 hour) to verify Standard Integration completion and validate solution designs for custom requests.

The custom integration requests should follow the format below:


Use Case

Current Experience

Desired Experience

Screenshots or Videos

Additional Notes

Show static path on Pointr Map 

Only dynamic path is visible

Allow users to create a static path to a destination on the map

Attach visuals where applicable

The static path should be shown with steps to follow in a separate view

After following the Pointr Developer Portal guidelines, if your developers experience any issues achieving Standard Integration, contact your Pointr Technical Project Manager using the designated format.

 

Support Session Rules

To ensure productive and efficient sessions with Pointr developers, the following procedures will be followed by Pointr TPMs:

Prior to Meetings

Pointr TPMs will:

  1. Consolidate questions and issues from your development team. This ensures:

    1. The right Pointr team members are present to support your developers.

    2. Minimization of time spent reviewing information already available in Pointr Developer Portal.

    3. Avoid unnecessary meetings for questions already addressed in documentation.

  2. Review Web/Mobile SDK integration questions and findings internally with Pointr developers.

  3. Check developer availability and schedule the meeting accordingly.

During and After Meetings

Pointr TPMs will:

  1. Monitor session duration and ensure meetings do not exceed the allotted time per program.

  2. Summarize discussions, including:

    1. Issues Addressed

    2. Ongoing Items

    3. Resolved Items

  3. And share this summary with your team for reference.


Prerequisites of Software Integration

Each integration program can only begin once the following prerequisites are completed. Pointr recommends that your developers or third-party integrators review the Pointr Developer Portal and fully understand the content related to the product being integrated before starting any program.


Action

Platform

Details

Access to Pointr Developer Portal is granted

Web/Mobile

  • Ensure your development team can access all relevant SDK and integration guides.

Credentials to fetch Pointr Mobile SDK are delivered

Mobile

  • Artifactory (Android)

  • Cocoapods (iOS)

Credentials to access Pointr Web SDK are delivered

Web

  • Pointr Cloud API URL

  • Client Secret

  • Client Internal Identifier

Pointr Cloud environment is set up and credentials/files are provided

Pointr Cloud

  • Pointr Cloud URL

  • Pointr Cloud License Key

Tip: Completing these prerequisites ensures that integration sessions are productive and focused on technical implementation rather than any access or configuration issues.

 

Issue Reporting & Troubleshooting

During software integration, if your developers encounter issues achieving the standard use cases, please report them to the Pointr TPM using the following standardized format for Mobile and Web SDK issues. 

Mobile SDK Issue Reporting

Category

Expected Data

Is Mandatory?

Client App Information

Mobile platform where issue occurs (iOS, Android, or both)

Yes

Integration Details

Pointr Mobile SDK version being used.

Yes

Integration Details

Development platform (iOS Swift, Android Kotlin, React Native, Flutter, Ionic, Xamarin, etc.)

Yes

Integration Details

Integration steps and code snippets (if applicable)

Yes

Integration Details

Custom configurations or settings (if applicable)

Yes

Development Environment Details

Software development environment (XCode Version, Android Studio Version)

No

Issue Details

Problem description and steps to reproduce along with expected vs. actual behavior (all applicable poi, site and building ids )

Yes

Issue Details

Frequency of issue (always, sometimes, rare)

Yes

Issue Details

Full stack traces for crashes/errors (if applicable)

Yes

Issue Details

Screenshots and/or video recordings

No

Device Information

Device model, OS version, and manufacturer

No

Web SDK Issue Reporting

Category

Expected Data

Is Mandatory?

Integration Details

Pointr Web SDK version being used

Yes

Integration Details

Integration steps and code snippets (if applicable)

Yes

Issue Details

Problem description and steps to reproduce along with expected vs. actual behavior (all applicable poi, site and building ids )

Yes

Issue Details

Frequency of issue (always, sometimes, rare)

Yes

Issue Details

Console errors, warning or exception from browser

Yes

Issue Details

Screenshots and/or video recordings

Yes

Device Information

Browser type and version

Yes

Device Information

Device model, OS version, and manufacturer (if applicable)

No

Device Information

Screen size, resolution and orientation

No

Tip: Providing complete logs, screenshots, screen recordings, SDK versions, and relevant code snippets helps the Pointr developers investigate, resolve, or suggest solutions efficiently and with the appropriate urgency.

Guidelines for Software Integration

To ensure a successful integration, Pointr defines standard guidelines for both Mobile and Web SDKs. These guidelines verify that your developers have implemented “out-of-the-box” Pointr features correctly. They apply to all integration programs.

Mobile SDK Integration Use Cases

Standard Integration ensures your app developers can use the Pointr Mobile SDK features in your host application. Further integration details are available in the Quick Start section of Pointr Developer Portal. 

The following validation schema confirms that standard SDK integration is complete:

  1. Add Pointr Mobile SDK to your project
  2. Start Pointr
  3. Display a Map
  4. Test Common Use Cases
    1. Highlight a POI
    2. Get User Position
    3. Start Wayfinding
    4. Listen to Geofence Events
    5. Add Custom Drawings
    6. Add Map Event Listeners

Web SDK Integration Use Cases

Standard Integration ensures your app developers can use the Pointr Web SDK features in your host application. Further integration details are available in the Quick Start section of Pointr Developer Portal. 

The following validation schema confirms that standard SDK integration is complete:


  1. Add the SDK to your Own Project
  2. Specify SDK Options
  3. Create a MapWidget Object
  4. Call the Start Function and Display a Map
  5. Test Common Use Cases
    1. Highlight a POI
    2. Start Wayfinding
    3. Add Map Event Listeners
  6. Add Custom Markers