Per-project admin key auth, drop ProjectID; MIT license; go 1.21
This commit is contained in:
@@ -1,8 +1,7 @@
|
||||
# liveops-go-sdk
|
||||
# rudder-go-sdk
|
||||
|
||||
Серверный Go SDK для LiveOps-платформы Rudder. Покрывает server-admin
|
||||
поверхность `/game/v1` (auth по `X-API-Key`, ключ — `GAME_ADMIN_API_KEY`
|
||||
на gateway).
|
||||
поверхность `/game/v1` (auth по `X-API-Key`).
|
||||
|
||||
## Install
|
||||
|
||||
@@ -14,14 +13,20 @@ go env -w GOPRIVATE=hub.rudder.build/*
|
||||
go get hub.rudder.build/rudder/rudder-go-sdk@latest
|
||||
```
|
||||
|
||||
Требуется Go 1.25+. Токен не нужен — репозиторий публичный.
|
||||
Требуется Go 1.21+. Токен не нужен — репозиторий публичный.
|
||||
|
||||
## Доступ
|
||||
|
||||
`APIKey` — это per-project Admin Key: поле «Admin Key» в настройках проекта
|
||||
в дашборде (app.rudder.build → проект → Settings). Ключ сам определяет
|
||||
проект, отдельный project ID не нужен. Храните его только на сервере —
|
||||
никогда не вшивайте в игровые клиенты.
|
||||
|
||||
## Usage
|
||||
|
||||
```go
|
||||
client, err := rudder.New(rudder.Config{
|
||||
APIKey: os.Getenv("GAME_ADMIN_API_KEY"),
|
||||
ProjectID: "your-project-id",
|
||||
APIKey: os.Getenv("RUDDER_ADMIN_KEY"),
|
||||
})
|
||||
if err != nil {
|
||||
// *rudder.APIError с кодом sdk/invalid-options
|
||||
@@ -44,7 +49,7 @@ page, err := client.Ugc.List(ctx, rudder.ListUgcParameters{Status: "pending"})
|
||||
var apiErr *rudder.APIError
|
||||
if errors.As(err, &apiErr) {
|
||||
apiErr.Status // HTTP status
|
||||
apiErr.Code // машинный код, константы в models.ErrorCode*
|
||||
apiErr.Code // машинный код из тела ошибки gateway
|
||||
apiErr.RequestID // корреляция с логами gateway
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user