Getting Started

Welcome to the Panviva Developer Portal. If you're here, it means that your business has tasked you with exploring the Panviva APIs and connecting your business apps with ours.

Panviva understands that organizations rely on a broad range of applications and SaaS offerings to power their business processes. Squeezing value from these IT assets and extending them into new use cases requires harmonious cooperation between these natively disparate systems.

To address these needs, Panviva has built the Panviva Cloud from the ground up to elegantly integrate with systems within a broader enterprise. The "API-first" architecture underpinning our platform enables what we call the "Panviva Ecosystem".

This article will empower you with all the information you need to setup your very first integration. In this article, we will cover the following topics:

  1. What is Panviva?
  2. The Panviva ecosystem
  3. Panviva API capabilities
  4. Before you start
  5. Understanding the terminology
  6. Making your first API call
  7. Understanding your User Profile

What is Panviva?

Panviva is software designed to make it easier for your front line and back office employees to perform their jobs right – the first time, every time. It offers real-time navigation to effortlessly guide your team members through complex policies, procedures and systems, helping to dramatically improve efficiency and accuracy, while simultaneously cutting operating costs and training times.

With Panviva, users can quickly and accurately navigate and coordinate multiple applications, disconnected information sources and critical regulatory procedures. A typical Panviva use-case is shown in the following video.

The Panviva eco-system

The Panviva Cloud platform utilizes a rich suite of APIs to support all inter-module communication. This same set of APIs is used to enable real-time integration (both inbound and outbound) with cooperating systems and platforms. Coined by Microsoft as "Eating your own Dog Food", these APIs power most of the Panviva functionality and an expansive range of integration scenarios.

Our APIs let you push documents or searches to specific users, fetch specific Panviva documents, images and external content, search for information (coming soon) and get usage analytics and statistics (coming soon).

Via this developer portal, we expose RESTful APIs that use HTTPS requests to GET, PUT, POST and DELETE data. Our APIs follow the JSON API specification 1.0.

Panviva capabilities

The current Panviva API suite offers an expansive range of integration scenarios:

  1. Live APIs
  2. Content APIs
  3. Search APIs (coming soon)
  4. Analytics APIs (coming soon)
  5. Natural Language Search APIs (coming soon)

 

Live APIs

The Panviva Live API extends Panviva's context awareness of Panviva, ensuring that the right content is displayed to the right user at the right time. This API enables other applications to interact with Panviva and push a Panviva document to a specified user.

Instead of waiting for the user to ask for guidance or search for information, business rules in other applications can define these situations and then display the most relevant Panviva content for that situation. Relevant information is displayed on the user’s desktop without them having to do anything at all.

The Live APIs currently expose 3 POST endpoints, namely:

  1. POST Live CSH
  2. POST Live Document
  3. POST Live Search

Details on each of these can be found by clicking "APIS", then clicking your API offering, then selecting the live API, as shown below. We recommend that you only do this once you have finished reading the rest of this article.

Some sample Live API scenarios can be found here.

 

Content APIs

Content APIs allow applications to pull the contents of a Panviva document in a JSON/HTML format and re-purpose it. For example, the Panviva content can be published on an external web site or inside another application. In this way, content created and stored in Panviva can be made available to different users in different formats and media.

The Content APIs currently expose 15 GET endpoints that help perform resource related operations within Panviva products, e.g. document, folder, file, container, image. Details on each of these can be found by clicking "API", then clicking your API offering, then selecting the content API you need. We recommend that you only do this once you have finished reading the rest of this article.

Some sample Content API scenarios can be found here.

Before you start

Before you start your API implementation you will need to have to certain environments and understand a few key concepts.

To help explain, lets assume you are a developer (Jane Smith <jane.smith@universal.com>) working at "Universal Exports" and you want to integrate with the Panviva APIs.

You will need to complete the following steps before you can make your first API call:

  1. You must have valid access to an existing Panviva environment.
    1. You need to know the URL for your Panviva instance. (For Jane, it is "https://universal.supportpoint.com")
    2. You need to have valid login credentials for your Panviva instance. (Jane's username within Panviva defaults to "jane.smith").
    3. Your Panviva account should be added to the appropriate roles so that you can create new documents and view all documents. (You don't have to have this, but it might make your life easier when you are testing and debugging your API implementation.)
  2. You need to have an account on the Panviva Developer Portal. If you haven't already done so, you must register and login to the Developer Portal. Registration is simple and can be done by navigating to the Signup page and completing the necessary verification.
  3. You must now request access to your Panviva environment API. By default, the ONLY Panviva APIs you will have access to are the ones that point to "https://preview.supportpoint.com". These APIs will be listed under the "APIS" tab as "Preview API Suite v2.x.x". You can use the Preview API Suite to explore the API documentation, but to implement your first API, you will need to request access to your own API environment.
    (Jane will need to request access to the APIs pointing to "https://universal.supportpoint.com". The APIs for Jane will be listed under the "APIS" tab as "Universal API Suite v2.x.x").
    1. To request access to the API, click this link to generate an email that will be sent to support@panviva.com.
    2. Once your request has been approved, you will be able to view your APIs under the "APIS" section of the Developer Portal.
  4. Apart from having access to your environment's APIs, you will also need to subscribe to an API Plan. Similar to APIs, the ONLY Panviva plans you will have access to by default are the ones that point to "https://preview.supportpoint.com". These plans will be listed under the "PLANS" tab as "Preview Developer Plan".
    Our Developer Portal has been setup such that once you have access to your environment's APIs, you will also have access to the plans.
    (Jane will have access to the following plans for the "https://universal.supportpoint.com" environment:
    → Universal Developer Plan
    → Universal Standard Plan
    → Universal Unlimited-300 Plan

    To subscribe to the plan, you need to do the following:
    1. Click the "PLANS" tab and ensure that you can see the plans for your environment.
    2. Select the plan that you want. (If you are testing, select the "Developer Plan". If you are in a production environment, select the "Standard" or "Unlimited-300" Plan.) Then click "Confirm".
    3. You should now be directed to your "Profile" page, which will show that you have successfully submitted a subscription request to your plan.
    4. Once your subscription request has been approved, you can view it in your Profile by clicking on your name and then "PROFILE". You now have access to your "Primary" and "Secondary" keys for your plan. You MUST keep your keys safe and never share them with anyone (including us). You can always regenerate your keys if you feel they have been compromised.

You have now completed all the necessary steps to make your first API call.

Understanding the terminology

 

API:

All APIs are listed under the "APIS" tab.

Each item links to a specific Panviva environment.

For example, in the image above, the "Preview API Suite v2.1.0" lists all APIs for the "https://preview.supportpoint.com" environment and "Universal API Suite v2.1.0" lists all APIs for the "https://universal.supportpoint.com" environment.

You can view the API documentation for each environment by clicking the environment links (eg. "Preview API Suite v2.1.0") on the "APIS" tab. After that, you can look at the documentation for specific APIs by clicking one of the links as shown in the image below.

 

Plan:

A plan contains one or more APIs (multiple versions where applicable) as well as a usage quota and the terms of use. To be able to use any APIs, you will need to subscribe to a plan.

For example, the following plans are available to access for the "https://universal.supportpoint.com" environment:
→ Universal Developer Plan
→ Universal Standard Plan
→ Universal Unlimited-300 Plan

Each of these plans offer different rate-limits, monthly quotas and SLAs.

Making your first API call

Once you have completed all the steps described in the " Before you start" section, making your first API call via the portal should be very easy.

To make an API call, you need to do the following:

  1. Click "APIS"
  2. Select your API (e.g. Universal API Suite v2.1.0)
  3. Select the API you'd like to try (e.g. Get Folder)
  4. Click "Try it"
  5. Set the Query Parameters id to 1
  6. Click "Send"
  7. You can now see the response and content from the Get Folders call.

Understanding your User Profile

You can view your Profile by clicking on your name and then "PROFILE". Your profile gives you access to all your subscriptions and to your keys for each subscription.

Additionally, you can generate analytics reports by clicking "Analytics reports" on your Profile page.