baningo

README

baningo

Go client for apiban.org

Installation

go get github.com/cgrates/baningo

Support

Join CGRateS on Google Groups here.

License

baningo is released under the MIT License. Copyright (C) ITsysCOM GmbH. All Rights Reserved.

Sample usage code

package main

import (
	"fmt"

	"github.com/cgrates/baningo"
)

func main() {
	apikeys := []string{"APIKey1", "APIKey2"}

	// get all banned IPs
	bannedIps, err := baningo.GetBannedIPs(apikeys...)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(bannedIps)

	// check only one IP
	isBanned, err := baningo.CheckIP("127.168.56.203", apikeys...)
	if err != nil {
		fmt.Println(err)
		return
	}
	if isBanned {
		fmt.Println("The IP is banned")
	} else {
		fmt.Println("The IP is not banned")
	}
}

Documentation

Index

• Variables
• func CheckIP(ctx context.Context, IP string, apiKeys ...string) (banned bool, err error)
• func GetBannedIPs(ctx context.Context, apiKeys ...string) (IPs []string, err error)

Variables

var (
	ErrRateLimit    = errors.New("rate limit exceeded")
	ErrBadRequest   = errors.New("bad request")
	ErrUnauthorized = errors.New("unauthorized")
	ErrEmptyID      = errors.New("empty ID received")
)

basic error returned by the API

var (
	RootURL = "https://apiban.org/api/"
)

RootURL the root URL for apiban server

Functions

func CheckIP

func CheckIP(ctx context.Context, IP string, apiKeys ...string) (banned bool, err error)

CheckIP this function will check if the IP is banned by apiban in case of a rate limit exceeded will continue with the next apiKey

func GetBannedIPs

func GetBannedIPs(ctx context.Context, apiKeys ...string) (IPs []string, err error)

GetBannedIPs this function will return all the IPs that are banned by apiban in case of a rate limit exceeded will continue with the next apiKey