Struct PIM Web API
StructPIM ships with a standard open web API, usable for all integration purposes. Use this to integrate your applications with StructPIM
API Authorization
In order to use the API, you need to set up an API key. This is done in the Settings -> API configuration node in StructPIM (Read more about this in the security settings article).
When you have generated an API key, you need to provide it prepended with ApiKey in the Authorization header of every request you make to the API in order to get access (example: ApiKey 50b9e03a-965d-440c-bff7-fc22de9ad0ec).
Swagger support
The StructPIM Api supports Swagger for documentation. We recommend installing the Swashbuckle Nuget package, if you are running your own installation of StructPIM, as this will give you complete and comprehensive API documentation with a web interface in which you can directly try out the API endpoints.
If you are running StructPIM as a Service (SaaS), Swagger is installed on your applications web Api. You can access it by going to [urlOfYourSaaSPIM]/swagger.
C# API client
We provide a C# API client, available in the official Nuget feed (Struct.PIM.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 StructPIM, you might want to go over the detailed API documentation.