カスタム API

1/my-cartridge
2    /cartridge
3        package.json
4        /rest-apis
5            /loyalty-info
6                api.json
7                schema.yaml
8                schema_v2.yaml
9                script.js
10                script_v2.js
11        /pipelines
12        /scripts
13        /controllers

1openapi: 3.0.0
2info:
3  version: 1.0.1
4  title: Loyalty Information API
5components:
6  securitySchemes:
7    ShopperToken:
8      type: oauth2
9      flows:
10        authorizationCode:
11          authorizationUrl: https://my-shortcode.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/my-org-id/oauth2/authorize
12          tokenUrl: https://my-shortcode.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/my-org-id/oauth2/token
13          scopes:
14            c_loyaltyInfo_r: Read loyalty information of a customer
15        clientCredentials:
16          tokenUrl: https://my-shortcode.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/my-org-id/oauth2/token
17          scopes:
18            c_loyaltyInfo_r: Read loyalty information of a customer
19paths:
20  /customers:
21    get:
22      summary: Get loyalty information for customer
23      operationId: getLoyaltyInfo
24      parameters:
25        - in: query
26          name: c_customer_id
27          required: true
28          schema:
29            type: string
30        - in: query
31          name: siteId
32          required: true
33          schema:
34            type: string
35            minLength: 1
36        - in: query
37          name: locale
38          required: false
39          schema:
40            type: string
41            minLength: 1
42      responses:
43        "200":
44          description: Shows loyalty information for the customer
45          content:
46            application/json:
47              schema:
48                type: object
49                properties:
50                  tier:
51                    type: string
52                  points:
53                    type: integer
54        "404":
55          description: Shows that the customer is not found
56          content:
57            application/json:
58              examples:
59                not_found:
60                  value:
61                    {
62                      "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/customer-not-found",
63                    }
64security:
65  - ShopperToken: ["c_loyaltyInfo_r"]

1var RESTResponseMgr = require("dw/system/RESTResponseMgr");
2
3exports.getLoyaltyInfo = function () {
4
5  var customerId = request
6    .getHttpParameterMap()
7    .get("c_customer_id")
8    .getStringValue();
9
10  /*
11    ... some lookup of loyalty data based on customer id ...
12  */
13
14  if (customerId === "customer1") {
15
16    var info = {
17      tier: "silver",
18      points: 14275
19    };
20
21    RESTResponseMgr
22      .createSuccess(info)
23      .render();
24
25  } else {
26
27    RESTResponseMgr
28      .createError(404, "customer-not-found", "Customer Unknown", "You provided an unknown customer ID.")
29      .render();
30
31  }
32
33};
34
35exports.getLoyaltyInfo.public = true;

1{
2  "endpoints": [
3    {"endpoint": "getLoyaltyInfo", "schema": "schema.yaml", "implementation": "script"},
4    {"endpoint": "getLoyaltyInfo", "schema": "schema_v2.yaml", "implementation": "script_v2"}
5  ]
6}

1- in: query
2  name: siteId
3  required: true
4  schema:
5    type: string
6    minLength: 1

1- in: query
2  name: locale
3  required: false
4  schema:
5    type: string
6    minLength: 1

1GET https://my-shortcode.api.commercecloud.salesforce.com/custom/loyalty-info/v1/organizations/my-org-id/customers?c_customer_id=customer1?siteId=MySite&locale=en-US

1openapi: 3.0.0
2info:
3  version: 1.0.1
4  title: Loyalty Information API
5components:
6  securitySchemes:
7    AmOAuth2:
8      type: oauth2
9      flows:
10        authorizationCode:
11          authorizationUrl: https://account.demandware.com/dwsso/oauth2/authorize
12          tokenUrl: https://account.demandware.com/dwsso/oauth2/access_token
13          scopes:
14            c_loyaltyInfo_rw: Read or Update loyalty information of a customer
15        clientCredentials:
16          tokenUrl: https://account.demandware.com/dwsso/oauth2/access_token
17          scopes:
18            c_loyaltyInfo_rw: Read or Update loyalty information of a customer
19paths:
20  /customers/{customerId}:
21    post:
22      summary: Update loyalty information for customer
23      operationId: updateLoyaltyInfo
24      parameters:
25        - in: path
26          name: customerId
27          required: true
28          schema:
29            type: string
30      requestBody:
31        content:
32          'application/json':
33            schema:
34              type: object
35              required:
36                - points
37              properties:
38                points:
39                  type: number
40                  minimum: 1
41                  maximum: 99999
42      responses:
43        "200":
44          description: Shows loyalty information for the customer
45          content:
46            application/json:
47              schema:
48                type: object
49                properties:
50                  tier:
51                    type: string
52                  points:
53                    type: integer
54        "404":
55          description: Shows that the customer is not found
56          content:
57            application/json:
58              examples:
59                not_found:
60                  value:
61                    {
62                      "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/customer-not-found",
63                    }
64security:
65  - AmOAuth2: ["c_loyaltyInfo_rw"]

1var RESTResponseMgr = require("dw/system/RESTResponseMgr");
2
3exports.updateLoyaltyInfo = function () {
4
5  var customerId = request
6    .getSCAPIPathParameters()
7    .get('customerId');
8
9  var requestBody = request
10    .httpParameterMap
11    .requestBodyAsString;
12  var requestJSON = JSON.parse( requestBody );
13
14  /*
15    ... Update loyalty points based on customer id and request body ...
16  */
17
18
19  if (customerId === "customer1") {
20
21    var updatedInfo = {
22      tier: "silver",
23      points: requestJSON.points
24    };
25
26    RESTResponseMgr
27      .createSuccess(updatedInfo)
28      .render();
29
30  } else {
31
32    RESTResponseMgr
33      .createError(404, "customer-not-found", "Customer Unknown", "You provided an unknown customer ID.")
34      .render();
35
36  }
37
38};
39
40exports.updateLoyaltyInfo.public = true;

1/error:
2  get:
3    summary: Throw an error
4    operationId: throwError
5    parameters:
6      - in: query
7        name: c_status
8        required: true
9        schema:
10          type: integer