cios-golang-sdk

README

OPTiM Cloud IoT OS Golang SDK (0.4.2)

It is a convenient SDK to use OPTiM Cloud IoT OS(CIOS) in Go language.

This SDK uses OpenAPI and is generated in code. OpenAPI will be split at a later date, but is now included in the code. It is imperfect.

Instration

go get -u github.com/optim-corp/cios-golang-sdk

Usage

Initialization

• If you want to use Prod Client

client = ciossdk.NewCiosClient(ciossdk.CiosClientConfig{
    Debug:             true,
    AutoRefresh:       true,
    Urls:              sdkmodel.ProdUrls(),
})

• If you want to use Pre Client

client = ciossdk.NewCiosClient(ciossdk.CiosClientConfig{
    Debug:             true,
    AutoRefresh:       true,
    Urls:              sdkmodel.PreUrls(),
})

• If you want to use Custom URL

client = ciossdk.NewCiosClient(ciossdk.CiosClientConfig{
    Debug:             true,
    AutoRefresh:       true,
    Urls: ciossdk.CIOSUrl{
        MessagingUrl:             " https://",
        LocationUrl:              " https://",
        AccountsUrl:              " https://",
        StorageUrl:               " https://",
        IamUrl:                   " https://",
        AuthUrl:                  " https://",
        VideoStreamingUrl:        " https://",
        DeviceManagementUrl:      " https://",
        DeviceMonitoringUrl:      " https://",
        DeviceAssetManagementUrl: " https://",
    },
})

Authentication

OAuthClientType	is Suppoted
Web	✅
Client	✅
Device	✅
Native	❌

• Client Auth
  • client id
  • client secret
  • request scope

client = ciossdk.NewCiosClient(ciossdk.CiosClientConfig{
    AuthConfig: ClientAuthConf(
           "clientID",
           "clientSecret",
           "scope",
   ),
})

• Refresh Token Auth
  • client id
  • client secret
  • refresh token
  • request scope

client = ciossdk.NewCiosClient(ciossdk.CiosClientConfig{
    AuthConfig: RefreshTokenAuth(
           "clientID",
           "clientSecret",
           "refreshToken",
           "scope",
   ),
})

• Device Auth
  • client id
  • client secret
  • assertion
  • request scope

client = ciossdk.NewCiosClient(ciossdk.CiosClientConfig{
    AuthConfig: DeviceAuthConf(
           "clientID",
           "clientSecret",
           "assertion",
           "scope",
   ),
})

The refresh token will only be executed once if the request fails.

Document

Authorization

• How to set AccessToken in context
• Auto Refresh AccessToken for instance

Account

• Me API
  • Get Me
• Group API
  • Get a Group
  • Get a Group by ResourceOwnerID
  • Get Groups (max limit 1000)
  • Get Groups no limit
  • Get Groups unlimited
  • Create a Group
  • Update a Group
  • Delete a Group
• ResourceOwner API
  • Get a ResourceOwner
  • Get a ResourceOwner by Group ID
  • Get ResourceOwner Map (Key ResourceOwner ID)
  • Get ResourceOwner Map (Key Group ID)
  • Get ResourceOwners
  • Get ResourceOwners (max limit 1000)
  • Get ResourceOwners no limit
  • Get ResourceOwners unlimited

FileStorage

• Bucket API
  • Get a Bucket
  • Get a Bucket by ResourceOwnerID and Name
  • Get or Create a Bucket
  • Get Buckets (max limit 1000)
  • Get Buckets no limit
  • Get Buckets unlimited
  • Create a Bucket
  • Update a Bucket
  • Delete a Bucket
• Node API
  • Get a Node
  • Get Nodes (max limit 1000)
  • Get Nodes no limit
  • Get Nodes unlimited
  • Create a Directory
  • Copy a Node
  • Move a Node
  • Rename a Node
  • Delete a Node
• File API
  • Download a File
  • Upload a File

Pub/Sub

• Channel API
  • Get a Channel
  • Get a Channel first on channel list response
  • Get or Create Channel
  • Get Channels (max limit 1000)
  • Get Channels no limit
  • Get Channels unlimited
  • Get Channel map by Channel ID key
  • Get Channel map by ResourceOwner ID key
  • Create a Channel
  • Update a Channel
  • Delete a Channel
• DataStore API
  • Get a Channel for DataStore
  • Get Channels for DataStore
  • Get a Object
  • Get latest Object
  • Get latest Object on Channels
  • Get Objects info (max limit 1000)
  • Get Objects info no limit
  • Get Objects info unlimited
  • Parse latest Object
  • Parse latest Object on channels
  • Get Stream first (websocket)
  • Get Stream (max limit 1000) (websocket)
  • Get Stream no limit (websocket)
  • Get Stream unlimited (websocket)
  • Parse Stream no limit (websocket)
  • Parse Stream unlimited (websocket)
  • Parse Stream first (websocket)
  • Delete a Object
  • Delete Objects on Channel
• Messaging API
  • Publish a message
  • Publish a message (payload only format)
  • Publish a message (json format)
  • Create Messaging instance (WIP)
    • How to use messaging instance (WIP)

Device

• Device Management API
  • Get a Device
  • Get a Device Inventory
  • Get Devices (max limit 1000)
  • Get Devices no limit
  • Get Devices unlimited
  • Create a Device
  • Update a Device
  • Device a Device
• Device Monitoring API
  • Get a Device Monitoring
  • Get Devices Monitoring
• Device Policy
  • Get Policies (max limit 1000)
  • Get Policies no limit
  • Get Policies unlimited
  • Create a Policy
  • Delete a Policy

Video

• Video Streaming API
  • Get a Video information
  • Get Videos information
  • Get a Thumbnail
  • Play Streaming
  • Stop Streaming

Geography

• Point API (WIP)
  • Get Points (max limit 1000)
  • Create a Point
  • Delete a Point
• Route API (WIP)
• Cycle API (WIP)

Collection (WIP)

License

• License API
  • Get Licenses

Contract

• Contract API
  • Get Contracts (max limit 1000)
  • Get Contracts no limit
  • Get Contracts unlimited

How to test client

package ciossdk_mock has mock interface

Usage

var client = ciossdk.NewCiosClient()
type MockBucket struct {
	ciossdk_mock.NoImplementFileStorage
}

func (*MockBucket) GetBuckets(ctx ciosctx.RequestCtx, request cios.ApiGetBucketsRequest) (cios.MultipleBucket, *_nethttp.Response, error) {
    return cios.MultipleBucket{}, nil, nil
}
func Test_sampleGetBucket(t *testing.T) {
    mock := &ciossdk_mock.MockClient{}
    mock.SetFileStorage(&MockBucket{})
    client = mock
    ....
}

How to Support

If you have any issues or questions, please raise them on Github issues.

LICENSE

The Apache-2.0 License

Copyright (c) 2021 OPTiM Corporation https://www.optim.co.jp/