Code Monkey home page Code Monkey logo

porkbun's Introduction

Go library for accessing the Porkbun API

Build Status PkgGoDev Go Report Card

An Porkbun API client written in Go.

porkbun is a Go client library for accessing the Porkbun API.

Examples

package main

import (
	"context"
	"fmt"

	"github.com/nrdcg/porkbun"
)

func main() {
	client := porkbun.New("secret", "key")

	ctx := context.Background()

	yourIP, err := client.Ping(ctx)
	if err != nil {
		panic(err)
	}

	fmt.Println(yourIP)
}

API Documentation

porkbun's People

Contributors

cullenmcdermott avatar dazwilkin avatar ldez avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

porkbun's Issues

Porkbun API rate limit of 1 query/second (presumably by API key)

I'm using your SDK (thank you for it!) for a Prometheus Exporter for Porkbun.

The exporter can be configured to query multiple domains.

I noticed that I was receiving 503s from Porkbun when making multiple requests.

Porkbun support told me that there's a 1 query/second rate limit on the API.

The support engineer is going to propose reflecting this in Porkbun's API documentation.

I think it would be useful to reflect in this SDK's README too.

If Porkbun API endpoint results in 503, HTML is returned in the response body

After adding support for Porkbun's /ssl endpoint, I'm able to generate 503s by exceeding 1qps.

The http#Client.Do does not return an error but this SDK returns an error on not http.StatusOK.

Because the Porkbun API returns HTML, the HTML is returned as the ServerError.Message which results in messy log message, e.g.:

status: 503 message: <html>
head><title>503 Service Temporarily Unavailable</title></head>
<body>
<center><h1>503 Service Temporarily Unavailable</h1></center>
<hr><center>openresty</center>
</body>
</html>

(Unfortunately) Porkbun support told me that they're unable to trap 503s (!?) as this is thrown by NGINX not their API server

I'm currently trapping this issue in my Exporter that uses this SDK but it may be better to trap it in the SDK.

Propose: capturing 503 (only) and replacing a standard "service unavailable" message.

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.