README.md

Go-Zendesk

Go-Zendesk is a Zendesk Core API client library for Go.

This library is used internally at MEDIGO Flume and the API resources are being implemented as needed.

It's work in progress. Use with caution.

Usage

package main

import (
  "log"

  "github.com/flume/go-zendesk/zendesk"
)

func main() {
    client, err := zendesk.NewClient("domain", "username", "password")
    if err != nil {
        log.Fatal(err)
    }
    ticket, err := client.ShowTicket(1)
    if err != nil {
        log.Fatal(err)
    }
    log.Printf("Requester ID is: %d", *ticket.RequesterID)
}

Find the complete API on https://godoc.org/github.com/flume/go-zendesk/zendesk#NewClient

Development

Linting

To lint the source code, use the command:

$ make lint

Testing

The project contains integration tests that uses the Zendesk API. To execute them you must provide the following values in a .env file:

ZENDESK_DOMAIN=<your-zendesk-domain>
ZENDESK_USERNAME=<your-zendesk-api-email>
ZENDESK_PASSWORD=<your-zendesk-api-password>

Then, to run the test, use the command:

$ make test

Please note that integration tests will create and alter entities in the configured Zendesk instance. You most likely want to run them against a Zendesk Sandbox instance.

Copyright and license

Copyright © 2020-2021 Flume Health, Inc. go-zendesk is licensed under the MIT License. See LICENSE for the full license text. Copyright © 2017 MEDIGO GmbH. go-zendesk is licensed under the MIT License. See LICENSE for the full license text.