Shoptet-Index-v3: Difference between revisions
m (Vinczei moved page Shoptet-v3 to Shoptet-Index-v3 without leaving a redirect) |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
{{api_callmethod | {{api_callmethod | ||
|method=GET | |method=GET | ||
|uri=/v3/Shoptet/<EshopID> | |uri=/v3/Shoptet/Index/<EshopID> | ||
}} | }} | ||
The <code>/Shoptet</code> API endpoint is used to fetch authentication data required to initiate a payment from a shop that is using the Barion Smart Gateway via the Shoptet SaaS system. | The <code>/Shoptet/Index</code> API endpoint is used to fetch authentication data required to initiate a payment from a shop that is using the Barion Smart Gateway via the Shoptet SaaS system. | ||
Prerequisites before use: | Prerequisites before use: | ||
| Line 30: | Line 30: | ||
The identifier must be included in the URL path, as in a REST API scheme. | The identifier must be included in the URL path, as in a REST API scheme. | ||
Example: <code>/v3/Shoptet/D53bA23F8</code>, where ''D53bA23F8'' is the Shoptet E-shop ID. | Example: <code>/v3/Shoptet/Index/D53bA23F8</code>, where ''D53bA23F8'' is the Shoptet E-shop ID. | ||
== Input properties == | == Input properties == | ||
| Line 57: | Line 57: | ||
==== Request ==== | ==== Request ==== | ||
<code><nowiki>GET https://api.barion.com/v3/Shoptet/D53bA23F8?partnerkey=25d0be652c564ff38f26aabc5971198b</nowiki></code> | <code><nowiki>GET https://api.barion.com/v3/Shoptet/Index/D53bA23F8?partnerkey=25d0be652c564ff38f26aabc5971198b</nowiki></code> | ||
==== Response ==== | ==== Response ==== | ||
Latest revision as of 12:19, 16 April 2019
Barion API: Fetch shop authentication data for Shoptet proxy
| GET | /v3/Shoptet/Index/<EshopID> |
|---|
The /Shoptet/Index API endpoint is used to fetch authentication data required to initiate a payment from a shop that is using the Barion Smart Gateway via the Shoptet SaaS system.
Prerequisites before use:
v3 This API endpoint is available in API v3 only.
Exclusive This API endpoint is exclusive to Shoptet.CZ integrations only!
Use cases
This API endpoint is designed to be used in the following scenarios:
Shoptet E-Shop ID
This unique ID is assigned to the shop by the Shoptet SaaS system, and must be set separately in Barion. The identifier must be included in the URL path, as in a REST API scheme.
Example: /v3/Shoptet/Index/D53bA23F8, where D53bA23F8 is the Shoptet E-shop ID.
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| PartnerKey | Guid |
|
The secret partner key of the caller, generated and maintained by Barion. This is obtained via special arrangements. See our sales team for details.
This must be supplied in the query string. |
Output properties
| Property name | Property type | Description |
|---|---|---|
| POSKey | Guid | The secret key of the shop used to initiate payments. |
| ShopOwnerEmailAddress | string | The e-mail address of the shop owner. |
Example call
Request
GET https://api.barion.com/v3/Shoptet/Index/D53bA23F8?partnerkey=25d0be652c564ff38f26aabc5971198b
Response
{
"POSKey": "b8c7c5fc207d47db88c3ddfb7e74d27d",
"ShopOwnerEmailAddress": "[email protected]",
"IsSuccessful": true,
"Errors": [ ]
}