Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osamingo/go-kenall
Unofficially kenall (ケンオール) client written by Go
https://github.com/osamingo/go-kenall
client go kenall postalcode
Last synced: about 21 hours ago
JSON representation
Unofficially kenall (ケンオール) client written by Go
- Host: GitHub
- URL: https://github.com/osamingo/go-kenall
- Owner: osamingo
- License: mit
- Created: 2021-02-08T08:01:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-02T05:52:47.000Z (over 1 year ago)
- Last Synced: 2024-08-02T20:45:47.640Z (3 months ago)
- Topics: client, go, kenall, postalcode
- Language: Go
- Homepage: https://kenall.jp
- Size: 121 KB
- Stars: 27
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome - osamingo/go-kenall - 05 star:0.0k fork:0.0k Unofficially kenall (ケンオール) client written by Go (Go)
README
# go-kenall
[](https://github.com/osamingo/go-kenall/actions?query=workflow%3ACI)
[](https://codecov.io/gh/osamingo/go-kenall)
[](https://goreportcard.com/report/github.com/osamingo/go-kenall/v2)
[](https://pkg.go.dev/github.com/osamingo/go-kenall/v2)
[](https://github.com/osamingo/go-kenall/blob/main/LICENSE)
## About
Unofficially [kenall](https://kenall.jp/) (ケンオール) client written by Go.
## Install
```shell
$ go get github.com/osamingo/go-kenall/v2@latest
```
## APIs supported by this library
- [郵便番号検索API](https://kenall.jp/docs/api-introduction/#%E9%83%B5%E4%BE%BF%E7%95%AA%E5%8F%B7%E6%A4%9C%E7%B4%A2api)
- [住所正規化API](https://kenall.jp/docs/API/postalcode/#%E4%BD%8F%E6%89%80%E6%AD%A3%E8%A6%8F%E5%8C%96%E6%A9%9F%E8%83%BD)
- [市区町村API](https://kenall.jp/docs/api-introduction/#%E5%B8%82%E5%8C%BA%E7%94%BA%E6%9D%91api)
- [日本の祝日API](https://kenall.jp/docs/API/holidays/)
- [法定休日確認API](https://kenall.jp/docs/API/businessday/)
- [自己IPアドレス確認API](https://kenall.jp/docs/API/whoami/#get-whoami)
- [法人番号検索API](https://kenall.jp/docs/api-introduction/#%E6%B3%95%E4%BA%BA%E7%95%AA%E5%8F%B7%E6%A4%9C%E7%B4%A2api)
## Usage
```go
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/osamingo/go-kenall/v2"
)
func main() {
cli, err := kenall.NewClient(os.Getenv("KENALL_AUTHORIZATION_TOKEN"))
if err != nil {
log.Fatal(err)
}
resAddr, err := cli.GetAddress(context.Background(), "1000001")
if err != nil {
log.Fatal(err)
}
addr := resAddr.Addresses[0]
fmt.Println(addr.Prefecture, addr.City, addr.Town)
// Output: 東京都 千代田区 千代田
resCity, err := cli.GetCity(context.Background(), "13")
if err != nil {
log.Fatal(err)
}
city := resCity.Cities[0]
fmt.Println(city.Prefecture, city.City)
// Output: 東京都 千代田区
res, err := cli.GetCorporation(context.Background(), "7000012050002")
if err != nil {
log.Fatal(err)
}
corp := res.Corporation
fmt.Println(corp.PrefectureName, corp.CityName)
// Output: 東京都 千代田区
}
```
## Articles
- [ケンオール通信第1号](https://blog.kenall.jp/entry/kenall-newsletter-vol1)
- This library has been featured on the official blog 🎉
## License
Released under the [MIT License](https://github.com/osamingo/go-kenall/blob/main/LICENSE).