ganblib

package module

v0.1.1 Latest Latest Go to latest Published: Jul 31, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/abyssparanoia/gmo-aozora-api-go

Links

Open Source Insights

README ¶

GMO Aozora Net Bank Open Api GO SDK

About

GMO あおぞらネット銀行について

https://gmo-aozora.com/

GMO あおぞらネット銀行 API 開発者ポータルについて

https://api.gmo-aozora.com/ganb/developer/

Version

1.0.0

Requirements

Golang 1.8+

Installation

get the repository from Github
$ go get github.com/abyssparanoia/gmo-aozora-api-go
get a package with the following command
$ go get github.com/antihax/optional

Getting started

Enviroment

Add the configuration below into your config file
vi conf.json

stg

conf.json

{
  "AUTH_BASE_URL": "https://stg-api.gmo-aozora.com/ganb/api/auth/v1",
  "JWT_ISSUER": "https://stg-api.gmo-aozora.com/",
  "AUTH_PATH": "/authorization",
  "TOKEN_PATH": "/token",
  "SALT": "PleaseDefineYourself"
}

configuration.go - Personal

	BasePath:      "https://stg-api.gmo-aozora.com/ganb/api/personal/v1",

configuration.go - Corporate

	BasePath:      "https://stg-api.gmo-aozora.com/ganb/api/corporation/v1",

configuration.go - Webhook

	BasePath:      "https://stg-api.gmo-aozora.com/ganb/api/webhooks/v1",

prod

conf.json

{
  "AUTH_BASE_URL": "https://api.gmo-aozora.com/ganb/api/auth/v1",
  "JWT_ISSUER": "https://api.gmo-aozora.com/",
  "AUTH_PATH": "/authorization",
  "TOKEN_PATH": "/token",
  "SALT": "PleaseDefineYourself"
}

configuration.go - Personal

	BasePath:      "https://api.gmo-aozora.com/ganb/api/personal/v1",

configuration.go - Corporate

	BasePath:      "https://api.gmo-aozora.com/ganb/api/corporation/v1",

configuration.go - Webhook

	BasePath:      "https://api.gmo-aozora.com/ganb/api/webhooks/v1",

Documentation

Autor

GMO Aozora Net Bank, Ltd. (open-api@gmo-aozora.com)

Licence

MIT

Documentation ¶

Index ¶

type Ganb
- func New(clientID string, clientSecret string, nonceSave func(string) error, ...) (Ganb, error)
type Token

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Ganb ¶

type Ganb struct {
	// contains filtered or unexported fields
}

Ganb is our main struct

func New ¶

func New(clientID string, clientSecret string, nonceSave func(string) error, nonceCheck func(string) error) (Ganb, error)

New setup the lib

func (Ganb) OAuthAuthorization ¶

func (g Ganb) OAuthAuthorization(sessionID string, scope string, redirectURI string) string

OAuthAuthorization methods Authorization used with oAuth

func (Ganb) OAuthGetToken ¶

func (g Ganb) OAuthGetToken(redirectURI string, code string, authMethod string) (Token, error)

OAuthGetToken methods used with oAuth

func (Ganb) OpenIDAuthorization ¶

func (g Ganb) OpenIDAuthorization(sessionID string, scope string, redirectURI string) (string, error)

OpenIDAuthorization methods Authorization used with OpenID

func (Ganb) OpenIDGetToken ¶

func (g Ganb) OpenIDGetToken(redirectURI string, code string, authMethod string) (Token, error)

OpenIDGetToken methods used with OpenID

func (Ganb) RefreshTokens ¶

func (g Ganb) RefreshTokens(refreshToken string) (Token, error)

RefreshToken refresh the session using a refresh token

type Token ¶

type Token struct {
	AccessToken      string `json:"access_token"`
	RefreshToken     string `json:"refresh_token"`
	Scope            string `json:"scope,omitempty"`
	TokenType        string `json:"token_type"`
	ExpiresIn        int    `json:"expires_in"`
	IDToken          string `json:"id_token,omitempty"`
	Error            string `json:"error"`
	ErrorDescription string `json:"error_description"`
	ErrorUri         string `json:"error_uri"`
}

Token data sctucture for both oAuth and openID tokens

Source Files ¶

View all Source files

ganb.go

Directories ¶

Path	Synopsis
corporateclient * GMO Aozora Net Bank Open API * * <p>オープンAPI仕様書（PDF版）は下記リンクをご参照ください</p> <div> <div style='display:inline-block;'><a style='text-decoration:none; font-weight:bold; color:#00b8d4;' href='https://gmo-aozora.com/business/service/api-specification.html' target='_blank'>オープンAPI仕様書</a></div><div style='display:inline-block; margin-left:2px; left:2px; width:10px; height:10px; border-top:2px solid #00b8d4; border-right:2px solid #00b8d4; transparent;-webkit-transform:rotate(45deg); transform: rotate(45deg);'></div> </div> <h4 style='margin-top:30px; border-left: solid 4px #1B2F48; padding: 0.1em 0.5em; color:#1B2F48;'>共通仕様</h4> <div style='width:100%; margin:10px;'> <p style='font-weight:bold; color:#616161;'>＜HTTPリクエストヘッダ＞</p> <div style='display:table; margin-left:10px; background-color:#29659b;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff;'>項目</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; color:#fff;'>仕様</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>プロトコル</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'>HTTP1.1/HTTPS</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>charset</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'>UTF-8</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>content-type</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'>application/json</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>domain_name</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'> 本番環境：api.gmo-aozora.com</br> 開発環境：stg-api.gmo-aozora.com </div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>メインURL</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'> https://{domain_name}/ganb/api/corporation/{version}</br> <span style='border-bottom:solid 1px;'>Version:1.x.x</span> の場合</br> https://api.gmo-aozora.com/ganb/api/corporation/<span style='border-bottom:solid 1px;'>v1</span> </div> </div> </div> <div style='margin:20px 10px;'> <p style='font-weight:bold; color:#616161;'>＜リクエスト共通仕様＞</p> <p style='padding-left:20px; font-weight:bold; color:#616161;'>NULLデータの扱い</p> <p style='padding-left:40px;'>パラメータの値が空の場合、またはパラメータ自体が設定されていない場合、どちらもNULLとして扱います</p> </div> <div style='margin:20px 10px;'> <p style='font-weight:bold; color:#616161;'>＜レスポンス共通仕様＞</p> <p style='padding-left:20px; font-weight:bold; color:#616161;'>NULLデータの扱い</p> <ul> <li>レスポンスデータ</li> <ul> <li style='list-style-type:none;'>レスポンスデータの値が空の場合または、レスポンスデータ自体が設定されない場合は「項目自体を設定しません」と記載</li> </ul> <li>配列</li> <ul> <li style='list-style-type:none;'>配列の要素の値が空の場合は「空のリスト」と記載</li> <li style='list-style-type:none;'>配列自体が設定されない場合は「項目自体を設定しません」と記載</li> </ul> </ul> </div> <div style='margin:20px 10px;'> <p style='font-weight:bold; color:#616161;'>＜更新系APIに関する注意事項＞</p> <ul> <li style='list-style-type:none;'>更新系処理がタイムアウトとなった場合、処理自体は実行されている可能性がありますので、</li> <li style='list-style-type:none;'>再実行を行う必要がある場合は必ず照会系の処理で実行状況を確認してから再実行を行ってください</li> </ul> </div> * * API version: 1.1.12 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)	* GMO Aozora Net Bank Open API * * <p>オープンAPI仕様書（PDF版）は下記リンクをご参照ください</p> <div> <div style='display:inline-block;'><a style='text-decoration:none; font-weight:bold; color:#00b8d4;' href='https://gmo-aozora.com/business/service/api-specification.html' target='_blank'>オープンAPI仕様書</a></div><div style='display:inline-block; margin-left:2px; left:2px; width:10px; height:10px; border-top:2px solid #00b8d4; border-right:2px solid #00b8d4; transparent;-webkit-transform:rotate(45deg); transform: rotate(45deg);'></div> </div> <h4 style='margin-top:30px; border-left: solid 4px #1B2F48; padding: 0.1em 0.5em; color:#1B2F48;'>共通仕様</h4> <div style='width:100%; margin:10px;'> <p style='font-weight:bold; color:#616161;'>＜HTTPリクエストヘッダ＞</p> <div style='display:table; margin-left:10px; background-color:#29659b;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff;'>項目</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; color:#fff;'>仕様</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>プロトコル</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'>HTTP1.1/HTTPS</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>charset</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'>UTF-8</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>content-type</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'>application/json</div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>domain_name</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'> 本番環境：api.gmo-aozora.com</br> 開発環境：stg-api.gmo-aozora.com </div> </div> <div style='display:table; margin-left:10px;'> <div style='display:table-cell; min-width:130px; padding:9px; border:1px solid #fff; color:#fff; background-color:#29659b;'>メインURL</div> <div style='display:table-cell; width:85%; padding:9px; border:1px solid #fff; background-color:#f8f8f8;'> https://{domain_name}/ganb/api/corporation/{version}</br> <span style='border-bottom:solid 1px;'>Version:1.x.x</span> の場合</br> https://api.gmo-aozora.com/ganb/api/corporation/<span style='border-bottom:solid 1px;'>v1</span> </div> </div> </div> <div style='margin:20px 10px;'> <p style='font-weight:bold; color:#616161;'>＜リクエスト共通仕様＞</p> <p style='padding-left:20px; font-weight:bold; color:#616161;'>NULLデータの扱い</p> <p style='padding-left:40px;'>パラメータの値が空の場合、またはパラメータ自体が設定されていない場合、どちらもNULLとして扱います</p> </div> <div style='margin:20px 10px;'> <p style='font-weight:bold; color:#616161;'>＜レスポンス共通仕様＞</p> <p style='padding-left:20px; font-weight:bold; color:#616161;'>NULLデータの扱い</p> <ul> <li>レスポンスデータ</li> <ul> <li style='list-style-type:none;'>レスポンスデータの値が空の場合または、レスポンスデータ自体が設定されない場合は「項目自体を設定しません」と記載</li> </ul> <li>配列</li> <ul> <li style='list-style-type:none;'>配列の要素の値が空の場合は「空のリスト」と記載</li> <li style='list-style-type:none;'>配列自体が設定されない場合は「項目自体を設定しません」と記載</li> </ul> </ul> </div> <div style='margin:20px 10px;'> <p style='font-weight:bold; color:#616161;'>＜更新系APIに関する注意事項＞</p> <ul> <li style='list-style-type:none;'>更新系処理がタイムアウトとなった場合、処理自体は実行されている可能性がありますので、</li> <li style='list-style-type:none;'>再実行を行う必要がある場合は必ず照会系の処理で実行状況を確認してから再実行を行ってください</li> </ul> </div> * * API version: 1.1.12 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
libs
personalclient
webhookclient

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL