Portal API Overview

The Portal API is used to manage a Vector Charts OEM deployment. It covers users, API tokens, custom charts, styles, background jobs, and instance-wide administration.

The Portal API is mounted under the /api/portal/ path prefix on the OEM server. For an OEM instance running at https://<your-host>:9909, the Portal API base URL is:

https://<your-host>:9909/api/portal

See Authentication for details on authenticating Portal API requests.

Categories

  • Authentication: log in, log out, and inspect the current session.
  • API Tokens: create, list, update, and revoke Core API tokens.
  • Charts: upload S-57 and S-63 charts, list uploads, and manage S-63 permits.
  • Styles: create and manage custom map styles.
  • Jobs: inspect background jobs and trigger maintenance operations.
  • Administration: manage users, accounts, and API tokens across every account on the instance. Admin-only.
VectorCharts.com © 2024, Zydro Marine Technologies, Inc. · vectorcharts.com