Web API

Struct PIM ships with a standard REST Api, that allows for any interaction with Struct PIM resources. Use this to integrate your applications with Struct PIM

About the API

The REST Api ships with every installation of Struct PIM. Access to the API is restricted by API keys issued within the Struct PIM application.

Newer versions of the API may include new features, but a major version (eg. v.3.) is always backwards compatible.

C# API client

We provide a C# API client, available in the official Nuget feed (Struct.App.Api.Client). We recommend using this, if you are working in C#, as it gets you going a lot faster compared to wrapping the API yourself.

API documentation

If you are implementing your integration using .NET and C#, we recommend having a look at our Demo project, which shows examples on how to get data through the Api and how to insert data using the Api. When you start implementing your integration to Struct PIM, you might want to go over the API introduction or the detailed API documentation.

Performance

The API is build for updating and reading large amounts of data in short time. All areas has extended support for batching data together to make the updating as smooth as possible.

We do not recommend using the API as a direct source for presentation if performance is the main focus. You should always transfer the data needed for presentation, from the API, to a fast read and search friendly cache layer.

This ensures optimal performance at all times.