Step by Step Guide to Building a Shopee API Integration in Go

Aug 11, 2024 • 6 minute read

Introduction

Hey there, fellow developer! Ready to dive into the world of e-commerce API integration? Today, we're tackling the Shopee API with Go. Shopee's API is a powerhouse for managing products, orders, and logistics on their platform. By the end of this guide, you'll have a solid integration up and running.

Prerequisites

Before we jump in, make sure you've got:

Go installed (I know you probably do, but just checking!)
Shopee API credentials (if you don't have these yet, hop over to Shopee's developer portal)
Your favorite Go IDE or text editor

We'll be using a few Go packages, but we'll cover those as we go along.

Setting up the project

Let's kick things off with a clean project structure:

shopee-api/
├── main.go
├── client/
│   └── client.go
├── auth/
│   └── auth.go
└── api/
    ├── product.go
    ├── order.go
    └── logistics.go

Initialize your Go module:

go mod init github.com/yourusername/shopee-api

Authentication

Shopee uses a signature-based authentication. Here's how to implement it:

// auth/auth.go
package auth

import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/hex"
    "strconv"
    "time"
)

func GenerateSignature(partnerId, apiKey, path string) string {
    timestamp := strconv.FormatInt(time.Now().Unix(), 10)
    baseString := partnerId + path + timestamp

    h := hmac.New(sha256.New, []byte(apiKey))
    h.Write([]byte(baseString))
    
    return hex.EncodeToString(h.Sum(nil))
}

Making API requests

Now, let's create a base client to handle our requests:

// client/client.go
package client

import (
    "net/http"
    "time"
)

type ShopeeClient struct {
    BaseURL    string
    HTTPClient *http.Client
    PartnerId  string
    ApiKey     string
}

func NewShopeeClient(baseURL, partnerId, apiKey string) *ShopeeClient {
    return &ShopeeClient{
        BaseURL:    baseURL,
        HTTPClient: &http.Client{Timeout: 10 * time.Second},
        PartnerId:  partnerId,
        ApiKey:     apiKey,
    }
}

// Implement methods for GET, POST, etc.

Implementing key Shopee API endpoints

Let's implement a few crucial endpoints:

// api/product.go
package api

func (c *ShopeeClient) GetProductList() ([]Product, error) {
    // Implementation here
}

// api/order.go
func (c *ShopeeClient) GetOrderDetails(orderId string) (Order, error) {
    // Implementation here
}

// api/logistics.go
func (c *ShopeeClient) GetShippingParameter(orderId string) (ShippingInfo, error) {
    // Implementation here
}

Error handling and rate limiting

Don't forget to handle those pesky errors and respect Shopee's rate limits:

// client/client.go
func (c *ShopeeClient) doRequest(req *http.Request) (*http.Response, error) {
    resp, err := c.HTTPClient.Do(req)
    if err != nil {
        return nil, err
    }
    
    if resp.StatusCode == http.StatusTooManyRequests {
        // Implement backoff strategy
    }
    
    // Handle other status codes
    
    return resp, nil
}

Testing the integration

Always test your code! Here's a quick example:

// client/client_test.go
func TestGetProductList(t *testing.T) {
    // Set up test client
    // Make API call
    // Assert results
}

Best practices and optimization

To keep your integration snappy:

Implement caching for frequently accessed data
Use Go's concurrency features for parallel requests
Batch API calls where possible

Conclusion

And there you have it! You've just built a solid foundation for a Shopee API integration in Go. Remember, this is just the beginning. There's a whole world of endpoints and features to explore in the Shopee API.

Keep coding, keep learning, and most importantly, have fun with it!

Resources

Now go forth and conquer the e-commerce world with your new Shopee integration!