Pimcore GraphQL

​

Extra information

System documentation: https://pimcore.com/docs/data-hub/current/Basic_Principle.html

​

Connector package documentation

​

Table of Contents

• 1. Setting up HTTP Client Pimcore
  • 1.1 Steps
• 2. Subscribing to entities from Pimcore
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to Pimcore
  • 3.1 Steps
  • 3.2 General concept

​

1. Setting up HTTP Client Pimcore

1.1 Steps

1. In Alumio Dashboard, go to Clients > HTTP Client. Create a new HTTP Client and select Pimcore GraphQL Client as the prototype of the HTTP Client.
2. Fill in the Base URI and API Key.
3. You can optionally enable logging of request to get the log of the authentication.
4. Save the HTTP Client for use.

​

2. Subscribing to Entities from Pimcore

2.1 Steps

1. Go to Connections -> Incoming and create a new incoming configuration and select Pimcore Subscriber as the subscriber.
2. Add Request URI for special end point. (Optional)
3. Add Request Method for the request.
4. Add Request Parameters needed to subscribe.
5. Select the Pimcore HTTP Client to use.
6. You can optionally add a transformer to transform the request parameters into something you will request from Pimcore.

2.2 General Concept We follow Pimcore documentation on building this connector, so you can easily use the connector based on Pimcore API Reference. Request URI The configuration name you want to subscribe from Pimcore will be added to the end of the Base URI set in the HTTP Client. Request Parameters These are the parameters you can provide to get the needed entity based on the Pimcore API Reference. For example when we try subscribing to “getAsset”. We can add the request parameter as follows. You will get the response like shown. Pimcore is using custom Query that can be changed from their dashboard, follow this Pimcore API Reference page for details. HTTP Client The HTTP Client configuration you will use to access Pimcore. Input Transformer Any transformer’s set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

​

3. Publishing Entity to Pimcore

3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Pimcore Publisher as the publisher.
2. Add Request URI for special end point. (Optional)
3. Fill in the Method that you want the publisher to perform with the data.
4. Add Request Parameters needed to publish.
5. Select the HTTP Client to use.

3.2 General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify the data using transformers. Request URI The configuration name you want to subscribe from Pimcore, it will be added to the end of the Base URI set in the HTTP Client. Method Currently we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method) for publishing data to Pimcore. Request Parameters Pimcore is using custom Query that can be changed from their dashboard, follow this Pimcore API Reference page for details. For example, this is when we try to create a document page. HTTP Client The HTTP Client configuration you will use to access Pimcore.