Magento2Go

Connects go to a Magento Community REST Api using swagger to generate the the go client and structs.

To download a specific tagged release, run:

go get github.com/localrivet/[email protected]

Import it as:

import github.com/localrivet/magento2go

Example

import (
	"fmt"
	"os"

	"github.com/joho/godotenv"
	"github.com/localrivet/magento2go"
)

var (
	api *magento2go.MagentoApi
)

func init() {

	err := godotenv.Load()
	if err != nil {
		fmt.Errorf("Error loading .env file: %s", err)
	}

	config := magento2go.Config{
		AccessToken: os.Getenv("MAGENTO_ACCESS_TOKEN"),
		Host:        os.Getenv("MAGENTO_STORE_HOSTNAME"),
		Path:        "/rest/default",
		Scheme:      os.Getenv("MAGENTO_STORE_SCHEME"),
		Debug:       false,
	}

	// create the client
	client, err := magento2go.NewCommunityClient(config)
	if err != nil {
		fmt.Print(err)
	}

	// create the api
	// timeout in seconds
	var timeout int64 = 300
	api = magento2go.NewMagentoApi(client, timeout)
}

func main() {
	products, err := api.GetAllProducts(0, 300)
	if err != nil {
		fmt.Println(err)
	}

	for _, product := range products {
		fmt.Println(product.Name)
	}
}

Issue With Magento's Api

Magento's REST Api has one major issue:

It doesn't actually follow it's own swagger documentation and requires fixing the raw json response string before marshalling it into a corresponding struct.

Testing

All tests are written using ginkgo

• https://github.com/onsi/ginkgo

Once your instance is up and running and you're ready to run the test run the following command.

ginkgo watch
# or
go test

Due to Magento's Api issues mocking the Api using their own specs for testing is not recommended as it will not match the actual output of Magento's Api.

Testing requires a locally or remotely run Magento dev instance. These tests are ran again a locally run Magento docker instance.

Local Setup

1. I recommend using Mark Shust's Docker Configuration for Magento He's done a fantastic job of putting this together and it makes running a local dev environment a breeze.

   Setup is easy:

   curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/onelinesetup | bash -s -- magento.test 2.4.3-p1

2. You're going to need a username and password to get it setup properly. They can be found at Adobe's Magento site.

   • Login or create an Adobe account. https://account.magento.com/customer/account/login/

   • Once logged in navigate to this URL and click Create A New Access Key. https://marketplace.magento.com/customer/accessKeys/

3. Setup a the local testing URL magento.test in your /ect/hosts file.

   127.0.0.1   magento.test

4. Install your Magento's cron. This will prevent headaches and battles with Magento's cache.

   bin/magento cron:install 

5. Login to your local Magento instance and create your access token.

   Login > System > Extensions > Integrations > Add New Integration

   On a local dev instance you can safely give permission for everything. Don't do this in production

6. Create a .env file for testing.

   MAGENTO_STORE_SCHEME=https
   MAGENTO_STORE_HOSTNAME=magento.test
   MAGENTO_ACCESS_TOKEN=<put your Magentos access token here>

Regenerating Swagger Client

Generate the Api client using swagger

swagger generate client -f magento.schema.json -a magento2go --default-consumes application/json

Api Methods Planned

Products

• GetProductBySku
• GetAllProducts

Orders & more

• Coming soon