Public PI Web API endpoint

Document created by gregor on Nov 24, 2016Last modified by Jarita Sirois on Aug 12, 2020
Version 3Show Document
  • View in full screen mode

Dear PI Developer Community,

 

We are excited to offer you a public PI Web API endpoint. The purpose of this public endpoint is to:

 

  • Provide developers access to a PI System who may not be able to access PI otherwise
  • Create code samples against the public endpoint and to host them under OSIsoft organization on GitHub
  • Offer developers a playground to exercise with PI Web API
  • Create a streamlined way to offer datasets in a PI System

 

We like to start off simple and enhance functionality over time. There’s currently not much data available but we plan adding more over time. In the beginning, we will limit access to read-only with a single set of credentials. We are continuously discussing the options to make this offering more attractive but need to learn how stable and reliable the endpoint will turn out to be. The initial scope is as follows:

 

  • Please see Public PI Web API - access information (please make sure you are signed in with your SSO account) - IF YOU GET ACCESS DENIED, PLEASE SEE THE NOTE AT THE BOTTOM. 
  • Read-only access
  • Indexed Search Crawler is available
  • For now we offer NuGreen database

 

The other thing is that we have shared code samples at PI Developers Club which utilize the public PI Web API at (devdata.osisoft.com/piwebapi). Because the public endpoint uses Basic authentication (as mentioned in the original post), there are 2 options to pass the credentials, as base64 encoded string or in clear text. With this, the easiest option is to find the information in the forums by searching for the base URI of the public endpoint. 

 

We encourage you to test your existing REST clients or to create new ones. You can find some helpful information for calling PI Web API, at the PI Web API Useful Links Nexus.

 

We like to learn from your experience; so we encourage you to share your thoughts and suggestions here with the community. If you have a question about how to programmatically access the public endpoint, please start a "new" question at RESTful PI System Access space. In case you find the public PI Web API endpoint unresponsive or otherwise in bad status, please drop us an email at PIDevClub@osisoft.com.

 

Disclaimer

The public PI Web API endpoint is intended for research and development purposes under the terms detailed in the PI Developers Club Agreement.
Although we are planning to continuously support and enhance the public PI Web API endpoint, we cannot guarantee data quality, availability nor a time period within which issues will be fixed.

 

NOTE: 

The answer covers 2 different aspects. The first one is about access to Customer Portal downloads. Software licenses are organized by sites belonging to organizations. Major requirements to gain access is that a) the Single-Sign-On (SSO) account is linked to a site, b) the site is licensed for the product and c) the site is covered by SRP which refers Software Reliance Program and represents the service agreement. With regards to the document containing the logon information for the public endpoint, a + c need to be fulfilled. If your company owns a site covered by SRP, you need to care that your SSO account becomes linked to that site. Please refer to How to get an OSIsoft Customer Portal Login and How to Download Products.

5 people found this helpful

Attachments

    Outcomes