Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Klarna API Reference
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client Klarna
- 1.1 Steps
- 2. Subscribing to entities from Klarna
- 2.1 Steps
- 2.2 General concept
- 3. Publishing entity to Klarna
- 3.1 Steps
- 3.2 General concept
1. Setting up HTTP Client Klarna
1.1 Steps
- In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
- Select Klarna HTTP Client as PlatForm and click next step
- Fill in the Base URI, Username and Password.
(For more information, see Klarna Authentication Reference) - You can optionally enable logging of request to get the log of the authentication.
- Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.
2. Subscribing to Entities from Klarna
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select either “Klarna - Checkout Subscriber”, “Klarna - Disputes Subscriber”, “Klarna - Hosted Payment Page Subscriber”, “Klarna - Merchant Card Service Subscriber”,“Klarna - Order Management Subscriber”, “Klarna - Payments Subscriber”, “Klarna - Settlements Subscriber” or “Klarna - Shipping Service Callback Subscriber” as the subscriber.
- Select the entity you want to subscribe to from Klarna.
- Add any request parameters needed to subscribe to the entity.
- Select the Klarna HTTP Client to use.
- You can optionally add a transformer to transform the request parameters into something you will request from Klarna.
- You can also optionally enable pagination to allow Alumio fetches paginated entities.
2.2 General Concept
We follow Klarna documentation on building this connector, so you can easily use the connector based on Klarna API Reference.
Entity
The entity you want to subscribe to Klarna. Please refer to the entities from Klarna API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Klarna API Reference .
Please look at the example below on how to fill path field when subscribing “sessions - Read an existing payment session” entity.
Based on the documentation, we can see that the end point require “session_id” as a parameter. That is why we set the “session_id” inside the path key in the Request Parameters.
Alumio will then make a request to Klarna with the URL /payments/v1/sessions/2db0ec9c-8531-5027-abec-85664f281fe7
- Path is the path parameter of the url. For example the {id}.
- Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0 - Payload is the data contained within a request.
HTTP Client
The HTTP Client configuration you will use to access Klarna.
3. Publishing Entity to Klarna
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select either “Klarna - Checkout Publisher”, “Klarna - Disputes Publisher”, “Klarna - Hosted Payment Page Publisher”, “Klarna - Merchant Card Service Publisher”,“Klarna - Order Management Publisher”, “Klarna - Payments Publisher” or “Klarna - Shipping Service Callback Publisher” as the publisher.
- Select the Method that you want the publisher to perform with the data.
- Select the Klarna entity you want the data to be published to.
- You can optionally add any query data to the request on the key query.
- You can optionally add any payload data to the request on the key payload.
- 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 payload using the Request Transformer.
Method
Currently, we support HTTP Post method, HTTP Put method, HTTP Patch method and HTTP Delete method on submitting data to Klarna.
Entity
We support publishing to most Klarna endpoints.
Please refer to Klarna API Reference page.
For example, we want to create a Payment Session. Please select “Post” as the Method and “sessions - Create a new payment session” as the entity of the publisher.
Based on the documentation, it requires a request body. That is why we set the request body inside the payload key inside Alumio data.
Alumio will send an API request to Klarna with URL /payments/v1/sessions
- Path is the path parameter of the url. For example the {id}.
- Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0 - Payload is the data contained within a request.
HTTP Client
The HTTP Client configuration you will use to access Klarna.