Web SDK Integration Checklist¶
Web SDK Integration Use Cases¶
Pointr Standard Integration refers to your app developers being able to use the “out of the box” Pointr Web SDK features on your host application. The following integration validation schema applies to all programs and verifies standard SDK integration is complete.
| Use Cases / Scenarios where applicable |
|---|
| Include Pointr Web SDK in the project |
| Include license keys and client internal identifier corresponding to Pointr Cloud environment |
| Pointr Content is fetched successfully |
| Pointr Maps and Content are displayed |
| Pointr Pathfinding works as expected |
| Pointr Search works as expected |
Issue Reporting & Troubleshooting Standards¶
During the Software Integration, in case you have any issues achieving the use cases stated in the validation matrices, please request your developer or project manager to report it to Pointr TPM in the following format*:
| Use Case | Pointr Demo App Behavior | Client App Behavior |
|---|---|---|
| Pointr Maps and Content are displayed | Pointr Maps and Content are displayed | No maps. Black screen is displayed after waiting for 1-2 minutes |
| Logs | Screen Recordings | Client App Code/Snippet |
|---|---|---|
| Enter full Logs of when the issue occurs | Attach recording of the behavior | Attach your app code or snippet that is used to perform use case |
* This is an example request case to better demonstrate the expected format. The actual values for all rows/columns will be provided by your app developers in an ideal scenario.
The idea of troubleshooting is to answer relevant questions to gain a better understanding of your integration questions or issues. In this way, Pointr Delivery Team can investigate, resolve or develop solutions to address the issue with the appropriate urgency and service levels. Therefore, it is advised to share your SDK versions, screenshots, full text logs, snippets, and/or screen recordings as needed. Here is the set of technical questions for your reference:
- Is it an issue on a Live or QA version of the client’s app?
- Is the issue specific to an environment (QA/PROD)?
- Is it reproducible in Pointr demo app (iOS/Android/Web)?
- Is the issue specific to a platform?
- If yes, which platform (iOS/Android/Web)?
- Is it specific to the device(s), browsers or operation system version?
- If yes, which device(s) or model(s)?
- If yes, what is the version of the operation system?
- If yes, what is the name and version of the browser?
- Are there any verbose logs of the issue?
- If yes, could you please provide?
- If not, could you please compile verbose logs?
- Is it reproducible in local setup, or is it a bug/crash report from Firebase, or another crash logging service?
- If it is reproducible in local setup, could you please share steps to reproduce?
- If it is not reproducible locally, how many users does it affect?
- If it is not reproducible locally, do they have Firebase actions or similar steps that they can share and lead to the issue?
How to Integrate Web SDK¶
The fundamental integration steps for clients who use Pointr Map Widget are the following:
- Login and download working project from Pointr Docs
- Add Pointr Web SDK to the your project
- On document ready, create an object of PointrWebSDK.Options with apiUrl, clientInternalIdentifier and clientSecret.
- Create PointrWebSDK.MapWidget(options) object with options you created in the previous step.
- Call start function of the MapWidget object
- This code will add Pointr Web SDK to the container with id “pointr-map” (will create if cannot find).
- If everything is running successfully, your site or building maps (along with the points of interest) should be displayed on the browser.
Further details about integration steps can be found in the Getting Started section under Pointr Docs.