Skip to content

OVI API Getting Started

Getting started

To get started with the OVI API, you need to aquire credentials for logging in. Please get in touch with us thru contact@synergysky.com.

High-level overview

The OVI CONNECT API is a very simplistic REST like API thats sole purpose is to expose methods for adding and/or removing scheduled sessions that maps your selected URL to a URI.

Thru the available endpoints, you can save or bulk-save up to batches of 1000.

---
config:
  layout: elk
  look: classic
  theme: 'forest'
---
sequenceDiagram
    autonumber
    participant wabe as WebApp Backend
    participant api as CONNECT API
    wabe->>+api: auth/gettoken
    api->>-wabe: Bearer token
    wabe->>+api: /save or /bulksave (URL to SIP-URI provisioning)
    api->>-wabe: get object id and SIP-URI
    wabe-->>api: update by using object id