https://github.com/mikespook/wc-api-golang

A Golang wrapper for the WooCommerce API.
https://github.com/mikespook/wc-api-golang

Last synced: 14 days ago
JSON representation

A Golang wrapper for the WooCommerce API.

• Host: GitHub
• URL: https://github.com/mikespook/wc-api-golang
• Owner: mikespook
• License: mit
• Created: 2016-11-25T01:25:29.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-11T00:33:49.000Z (over 7 years ago)
• Last Synced: 2024-06-20T17:29:44.388Z (5 months ago)
• Language: Go
• Size: 8.79 KB
• Stars: 7
• Watchers: 4
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WooCommerce API - Golang Client

A Golang wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.

[![build status](https://secure.travis-ci.org/mikespook/wc-api-golang.svg)](http://travis-ci.org/mikespook/wc-api-golang)

## Installation

```bash

$ go get github.com/mikespook/wc-api-golang/woocommerce

```

## Getting started

Generate API credentials (Consumer Key & Consumer Secret) following this instructions 

.

Check out the WooCommerce API endpoints and data that can be manipulated in .

## Setup

Setup for the new WP REST API integration (WooCommerce 2.6 or later):

```golang

import (

  wc "github.com/mikespook/wc-api-golang/woocommerce"

)

var woocommerce = wc.NewClient(

    "http://example.com", 

    "ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", 

    "cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

    &wc.Options {

        API: true,

        Version: "wc/v1",

    },

);

```

### Paramaters

|       Option      |   Type   |                Description                 |

| ----------------- | -------- | ------------------------------------------ |

| `store`           | `string` | Your Store URL, example: http://woo.dev/   |

| `ck`              | `string` | Your API consumer key                      |

| `cs`              | `string` | Your API consumer secret                   |

| `options`         | `*wc.Options`  | Extra arguments (see client options table) |

#### Client options

|        Option       |   Type   |                                                      Description                                                       |

|---------------------|----------|------------------------------------------------------------------------------------------------------------------------|

| `API`            | `bool`   | Allow make requests to the new WP REST API integration (WooCommerce 2.6 or later)                                      |

| `APIPrefix`     | `string` | Custom WP REST API URL prefix, used to support custom prefixes created with the `rest_url_prefix` filter               |

| `Version`           | `string` | API version, default is `v3`                                                                                           |

| `Timeout`           | `time.Duration`    | Request timeout, default is `15`                                                                                       |

| `VerifySSL`        | `bool`   | Verify SSL when connect, use this option as `false` when need to test with self-signed certificates, default is `true` |

| `QueryStringAuth` | `bool`   | Force Basic Authentication as query string when `true` and using under HTTPS, default is `false`                       |

| `OauthTimestamp`   | `time.Time` | Custom oAuth timestamp, default is `time.Now()`                                                                            |

## Methods

|    Params    |   Type   |                         Description                          |

| ------------ | -------- | ------------------------------------------------------------ |

| `endpoint`   | `string` | WooCommerce API endpoint, example: `customers` or `order/12` |

| `data`       | `interface{}`  | Only for POST and PUT, data that will be converted to JSON   |

| `parameters` | `url.Values`  | Only for GET and DELETE, request query string                |

### GET

```golang

rc, err := woocommerce.Get(endpoint, parameters)

```

### POST

```golang

rc, err := woocommerce.Post(endpoint, data)

```

### PUT

```golang

rc, err := woocommerce.Put(endpoint, data)

```

### DELETE

```golang

rc, err := woocommerce.Delete(endpoint, parameters)

```

### OPTIONS

```golang

rc, err := woocommerce.Options(endpoint)

```

#### Response

All methods will return a `io.ReadCloser` and `nil` on success or an `error` on failure.

## Release History