Smart API features/OData+ resources - Intergraph Smart API Manager - 5.0 - Help

Intergraph Smart API Manager Help
Language
English
Product
Intergraph Smart API Manager
Search by Category
Help
Smart API Manager Version
5.0

All Smart APIs share certain features, for example:

  • Security - authorization is required. Clients must include an access token with every request to a Smart API.

  • OData+ - resources that follow well-established protocols for managing data created with Hexagon PPM products.

    Smart APIs implement OData+ resources based on requirements. That is, you may not find a Files endpoint for every Smart API, but if you do, it operates in a consistent, reliable fashion because it follows a published protocol.

  • Smart API Explorer - used to explore available resources, data structures, input parameters, response formats and more. See Explore a Smart API for details.

The following topics describe some of these common features for Smart APIs.

Sample Smart API and Smart API Manager Instance

The SampleService Smart API and sample Smart API Manager instance are currently unavailable.

The SampleService Smart API and the sample Smart API Manager instance referenced in this documentation, and previously deployed on the sam.spclouddave.com server, are no longer available. We plan to replace them after the Smart API Manager 6.0 release.

What can I use instead?

To follow along with the examples in this documentation, you can use any Smart API that your company has deployed and the instance of Smart API Manager that it is registered with. For help installing and configuring Smart API Manager, see the Smart API Manager Installation and Configuration Guide. For help installing and configuring a Smart API, see the documentation for that Smart API on our documentation web site at https://docs.hexagonali.com.

To demonstrate OData+ resources, some topics refer to the following SampleService Smart API:

https://sam.spclouddave.com/SampleService/Sppid/v2/

This Smart API is secured by the following instance of Smart API Manager:

https://sam.spclouddave.com/sam/

The SampleService Smart API is registered with this instance of Smart API Manager and is thus secured with OAuth 2.0, meaning you must have an access token when requesting its resources. See the following two sections for details.