API integration
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
The Struct PIM API provides programmatic access to your data, allowing you to retrieve, update, and manage entities such as products, variants, categories, and attributes and more.
Using the API, you can extend how you work with data in Struct by automating processes, handling large data operations efficiently.
The API is built to support both simple and advanced use cases, enabling you to start quickly and expand your implementation as needed.
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.
What you can do with the API
Access your Struct data directly, allowing you to query products, variants, categories, and attributes as needed.
Perform bulk operations efficiently, using batching to create, update, or process large amounts of data in fewer requests.
Integrate API operations into your existing processes, allowing data to be updated and maintained consistently across your Struct environment.
Requirements
Before working with the API, you need acces to the following:
API key
Before working with the API, you need to create an API key in your Struct environment. This key is used to authenticate your requests and control access to your data.
Navigate to Settings and open the API configuration section. From here, you can create a new API key and copy it for use in your requests.
The API key should be stored securely and only used in trusted environments.
For a detailed guide, see: How to set up and edit API configurations
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.
Related articles
Last updated