@inovitas/infra3dapi

Installation

NPM Package

The API can be installed as a package using npm. To install it from the npm package repository, simply type:

npm install @inovitas/infra3dapi

CDN Download

Alternatively, you can obtain the API from a CDN. To get the latest version, add the following script to your HTML file:

<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@latest/infra3dapi.js"></script>

We recommend using a specific version in your project. To get a specific version, use the following script and adjust the version accordingly:

<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@1.0.0/infra3dapi.js"></script>

Note: Please do not name the <div> in which the viewer is initialized as "infra3d" as this may cause internal conflicts.

Core Concept

To use the API, you can call the init functions in infra3dapi. After loggin in and initializing the view (with manager.initView()), you will get a viewer object. This viewer object can then be used to add event-listeners to different events emitted by the viewer (like viewer.geoframechanged) or to call some functions (like viewer.getRoutes() or viewer.movePosition()).

Authentication

1. Register your OAuth 2.0 application with our sales team to obtain credentials (client_id and client_secret).
2. Develop a server-side component to securely use these credentials, obtaining an access token from infra3D.
3. Your server-side component fetches the access token using client credentials, which can then be shared with your client app.
4. Your client app uses this token to authenticate with infra3D for requested services, refreshing it via the server component when expired. Remember to treat the client_secret like a password, avoiding exposure in client-side environments for enhanced security.

Changelog

1.0.0 - 17.05.2024

Bugfixes

• Restoration of toolbar and top bar functionality: They can now be shown and hidden smoothly.

Added

• Introduction of machine authentication and a new corresponding example.
  • Added: Option for access token in the init function.
  • Added: Refresh token for the init function.
• Typings

Changed

• Examples have been updated to accommodate the new authentication process.

Deleted

• Interactive login functions.
• Removed: Two options from the init function:
  • demoAccess
  • redirectPath

0.2.8 - 08.04.2024

Added

• Integrated and documented functions
  • moveToPosition
  • moveToCampaign
  • lookAtPosition
  • getRoutes

0.2.7 - 04.04.2024

Added

• Improved documentation
  • Description of the event types
  • Description of further settings

Changed

• Adaptation to the existing examples

0.2.4 - 14.03.2024

Bugfixes

• Troubleshooting with internal module

0.2.3 - 09.02.2024

Added

• Demo Access Login
• Documenation

Changed

• Adoption of adjustments to the UI base of infra3D Edit

Bugfixes

• Various minor adjustments

0.2.0 - 30.01.2024

Added

• Edit functionality