Integrating Orbify with your application is a straightforward process that can be tailored to meet your specific needs. Orbify provides several integration methods, allowing you to seamlessly incorporate its powerful capabilities into your existing workflow. This guide will walk you through the different methods of integration, from embedding content directly to utilizing the Orbify API for advanced programmatic access.
Step 1: Embedding Content
One of the simplest ways to integrate Orbify with your application is by embedding specific components from your Orbify reports directly into your external platform. This method allows you to display rich, interactive content without extensive development work.
Steps to Embed Content:
Prepare the Reports: Start by organizing and finalizing the reports within your Orbify workspace. Ensure that the content is exactly how you want it to appear in your application.
Generate the iFrame Code: Once your report is ready, generate the iframe code for the specific content you want to embed.
Embed the Code: Insert this iframe code into the HTML of your application where you want the Orbify content to appear.
This approach is ideal for quickly adding visual and interactive elements to your application.
Step 2: Embedding Reports
Orbify also allows for entire reports to be shared externally through a dedicated public link. This link can be either directly accessed by users or embedded within your application using an iframe, providing a more integrated experience.
Steps to Embed Reports:
Generate a Public Link: After finalizing your report, generate a public link from your Orbify workspace.
Share or Embed: You can choose to share this link directly with users or embed it within your application using an
iframeto present the report seamlessly within your app’s interface.
This method is perfect for sharing comprehensive data insights without requiring users to leave your application.
Step 3: Embedding Public Views (Orbify Explorer)
If you want to make your Orbify reports publicly accessible, you can publish them in the Orbify Explorer view. This feature provides a public URL that can be shared widely or embedded into your application.
Steps to Embed Public Views:
Publish the Report: Publish the report within the Orbify Explorer view to make it publicly accessible.
Copy the Public URL: After publishing, copy the public URL generated for the report.
Share or Embed: This URL can be shared directly or embedded within your application, similar to embedding reports.
This option is ideal for creating publicly accessible resources or dashboards that anyone can view.
Public view example
Step 4: API Access
For more advanced integration, Orbify offers an API that provides programmatic access to its features. The API allows you to create and manage projects and reports, as well as access various data layers, including tiled map layer URLs. This method is best suited for developers who need a deeper level of integration and customization.
Steps for API Access:
Utilize the API: Use the Orbify API to create and manage your projects and reports programmatically. This gives you the flexibility to automate processes and integrate Orbify’s features into your application at a deeper level.
Integrate Programmatically: Access and integrate content using the API, including embedded options and other data access methods offered by Orbify.
API integration is powerful for applications requiring dynamic and automated interactions with Orbify’s data and tools.
Conclusion
Integrating Orbify into your application can greatly enhance its functionality by adding rich, interactive content. Whether you choose to embed specific components, share entire reports, or leverage the API for advanced integration, Orbify’s tools can be seamlessly integrated into your existing workflow. Each method provides a different level of depth and customization, allowing you to tailor the integration to your application's needs.
For further guidance and detailed instructions, you can explore the Orbify API documentation and learn more about integrating Orbify with GIS tools like QGIS. By following these steps, you can make the most of Orbify’s powerful capabilities and elevate the user experience of your application.