java springBoot对接shopify webhook http

java springBoot对接shopify webhook http

最近在用java springboot 对接 shopify api ,需要用到 webhook的功能,因为官方文档好像没有java的实现,然后百度了一些文章,基本都是将一些概念,并没有实际的实现细节,也花了点时间才整明白,所以记录一下

准备

  1. java springboot
  2. shopify相关文档资料
    api文档: 文档
    shopify webhook shopify webhook
    shopify帮助中心 帮助中心
    其他基本认识就不在这里赘述,不知道的先学习上面的内容

使用

springboot 创建url用于作为webhook的地址

@RestController
@RequestMapping("/webhook")
@Slf4j
public class WebHookController {
    @PostMapping("shopify")
    public ResponseEntity<Void> webHookShopify(@RequestBody String body) {
        log.info("shopify webhook:{}", body);
        //body就是订阅webhook的内容了,类似于支付回调,可以写自己要处理的业务了
        return ResponseEntity.ok().build();
    }
}

然后把服务发布到线上(这里因为shopify webhook要用https,所以要配置好)
假设服务发布之后 这个接口最终为:

https://api.xxx.abc.com/webhook/shopify

然后就可以调用api创建一个webhook了,以下以curl为例,创建一个 商品更新的webhook订阅
参考文档:
https://shopify.dev/docs/api/admin-rest/2024-07/resources/webhook#post-webhooks

curl -d '{"webhook":{"address":"https://api.xxx.abc.com/webhook/shopify","topic":"products/update","format":"json"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2024-07/webhooks.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

结果返回一个json含有webhook信息就成功了
然后看看 服务日志,当商品信息更新时,https://api.xxx.abc.com/webhook/shopify 就会被调用,打印出一个相关的信息,就可以在里面做相关业务处理了

  • 4
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
下面是一个简单的 Spring Boot 控制器,用于响应 ShopifyWebhook 通知: ```java @RestController public class ShopifyWebhookController { @PostMapping("/webhooks/orders/create") public ResponseEntity<String> handleOrderCreate(@RequestBody String payload, @RequestHeader("X-Shopify-Topic") String topic) { if ("orders/create".equals(topic)) { // 处理订单创建通知 // 解析 payload 并处理相应的业务逻辑 return ResponseEntity.ok("Received order create notification."); } return ResponseEntity.badRequest().build(); } @PostMapping("/webhooks/orders/updated") public ResponseEntity<String> handleOrderUpdate(@RequestBody String payload, @RequestHeader("X-Shopify-Topic") String topic) { if ("orders/updated".equals(topic)) { // 处理订单更新通知 // 解析 payload 并处理相应的业务逻辑 return ResponseEntity.ok("Received order update notification."); } return ResponseEntity.badRequest().build(); } // 处理其他 ShopifyWebhook 通知 } ``` 在这个示例中,我们为 Shopify 的订单创建和更新事件创建了两个 POST 路由。当 Shopify 向这些路由发送通知时,控制器中的相应方法将被调用。请求的正文将作为字符串传递给 `@RequestBody` 参数,而 `X-Shopify-Topic` 标头将包含 Shopify 发送的通知主题。 为了使该控制器能够接收 ShopifyWebhook 通知,我们需要将公共网址(例如 ngrok 或 Heroku 提供的网址)添加到 Shopify 中。在 Shopify 后台中,我们需要转到“通知”设置,并在“Webhook”选项卡下创建相应的 Webhook。在创建 Webhook 时,我们需要提供 Webhook 的目标 URL(即我们的 Spring Boot 控制器的 URL)和要接收的通知类型。注意,我们需要使用 HTTPS 协议提供 URL。 下面是一个简单的 Webhook 创建示例,用于为 Shopify 的订单创建事件创建 Webhook: ```shell curl -X POST \ https://my-shop.myshopify.com/admin/api/2021-04/webhooks.json \ -H 'Authorization: Basic M2...Nk=' \ -H 'Content-Type: application/json' \ -d '{ "webhook": { "topic": "orders/create", "address": "https://my-app.com/webhooks/orders/create", "format": "json" } }' ``` 此代码将在 Shopify 中创建一个 Webhook,用于在订单创建时向 `https://my-app.com/webhooks/orders/create` 发送通知。在实际使用中,我们需要将 `address` 参数替换为我们应用程序的公共 URL。 需要注意的是,我们还需要将 Shopify API 的访问令牌提供给我们的应用程序,以便我们可以访问 Shopify 的 API 并处理 Webhook 的通知。在此示例中,我们将访问令牌作为 HTTP 授权标头的基本身份验证凭据传递。但是,为了更安全地处理凭据,我们建议使用 OAuth 认证流程来获取访问令牌。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值