Giter Club home page Giter Club logo

go-baselinker's Introduction

GoLang BaseLinker API

go-baselinker is a Go client library for accessing the BaseLinker service.

Currently, library is BETA version and testing only on Go version 1.12.

Library not implement each of method from BaseLinker API Documentation yet.

Usage

import "github.com/oxess/go-baselinker"

Construct a new BaseLinker client. Base API url is publish in Documentation.

For generate api key must go to "My account" -> "API" -> type name of application and click "Generate token".

baseLinkerUrl := "https://api.baselinker.com/connector.php"
baseLinkerToken := "xxx"

baseLinker := baselinker.NewBaseLinker(baseLinkerUrl, baseLinkerToken)

Example

Get logs kind of "create new order", "change order status" from the journal.

journalListParameters := baselinker.GetJournalListParameters{
    Types: []int{
        baselinker.LogTypeCreateNewOrder, 
        baselinker.LogTypeChangeOrderStatus
    },
}
logs, err := baseLinker.GetJournal(journalListParameters)

Get order by the id.

order, err := baseLinker.GetOrder(orderId)

Errors

BaseLinker return field "status" with values: "SUCCESS" or "ERROR". When status is "ERROR" then it add fields: "error_message" and "error_code".

Library supports errors by return error object but with custom field "code". Each error allow check code and compare it with baselinker error code list. Example:

order, err := baseLinker.GetOrder(orderId)
if nil != err {
    if err.CodeError() == ErrorCodeAccountBlocked {
        panic("Your %s account is blocked!", baseLinkerToken)
    } else {
        panic(err.Error()) // <-- here is baselinker error message
    } 
}

Developed methods

Name Description
GetJournal Get list of logs
GetOrders Get list of orders
GetOrder Get single order by the id

Versioning

Versioning is base on semver. The new version is release by a new tag.

Licence

This library is distributed under the BSD 3 Licence, see LICENSE for more information.

Contributing

Author of this library is Mikołaj Jeziorny.

If you want to help with development it - fork me!

go-baselinker's People

Contributors

oxess avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.