Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 3.93 KB

README.md

File metadata and controls

76 lines (46 loc) · 3.93 KB
Raw

IBM Cloud Unity SDK Core

Build Status wdc-community.slack.com semantic-release CLA assistant

The IBM Cloud Unity SDK Core is a core project of Unity SDKs generated using the IBM OpenAPI SDK generator. The core should be added to the Assets directory of your Unity project

Table of Contents

Before you begin

Ensure that you have the following prerequisites:

  • Unity. You can use the free Personal edition.

Configuring Unity

  • Change the build settings in Unity (File > Build Settings) to any platform except for web player/Web GL. The IBM Watson SDK for Unity does not support Unity Web Player.
  • If using Unity 2018.2 or later you'll need to set Scripting Runtime Version and Api Compatibility Level in Build Settings to .NET 4.x equivalent. We need to access security options to enable TLS 1.2.

Getting the IBM Unity SDK Core and adding it to Unity

You can get the latest SDK Core release by clicking here.

The IBM Unity SDK Core is a dependency of Unity SDKs generated using the IBM OpenAPI SDK generator. It should be added to the Assets directory of your Unity project. _Optional: rename the Core directory from unity-sdk-core to IBMSdkCore.

Authentication Types

There are several flavors of authentication supported in this package. To specify the intended authentication pattern to use, the user can pass in the parameter authentication_type. This parameter is optional, but it may become required in a future major release. The options for this parameter are basic, iam, and icp4d.

basic

This indicates Basic Auth is to be used. Users will pass in a username and password and the SDK will generate a Basic Auth header to send with requests to the service.

iam

This indicates that IAM token authentication is to be used. Users can pass in an iam_apikey or an iam_access_token. If an API key is used, the SDK will manage the token for the user. In either case, the SDK will generate a Bearer Auth header to send with requests to the service.

icp4d

This indicates that the service is an instance of ICP4D, which has its own version of token authentication. Users can pass in a username and password, or an icp4d_access_token. If a username and password is given, the SDK will manage the token for the user. A icp4d_url is required for this type. In order to use an SDK-managed token with ICP4D authentication, this option must be passed in.

Questions

If you are having difficulties using the APIs or have a question about the IBM Watson Services, please ask a question on dW Answers or Stack Overflow.

Open Source @ IBM

Find more open source projects on the IBM Github Page.

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.

Contributing

See CONTRIBUTING.md.