Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.79 KB

README.md

File metadata and controls

51 lines (32 loc) · 2.79 KB
Raw

Creatubbles API Client Unity SDK

Creatubbles API Client Unity SDK is a simple library built to help you communicate with the latest Creatubbles API.

Current SDK version: 0.1.4 (see changelog) Supported Unity versions: 5.4.x and newer
Supported output platforms: iOS, macOS (and possibly others, not yet confirmed)

NOTE! Library is still under development, and the SDK API might change in the future versions.

Documentation

SDK API reference (Doxygen generated) is available under Docs/reference/html/ as index.html.

Installation

Copy Assets/Scripts/Creatubbles to you project's Assets/Scripts folder.

QuickStart

  1. Contact us at [email protected] to obtain application ID and secret.

  2. Implement IApiConfiguration including your application ID and secret.

    See CreatubblesConfiguration for example implementation.

  3. SDK project contains a demo scene CreatubblesDemo, which can be used to check how the SDK is working.

  4. Implement ISecureStorage.

    See InMemoryStorage for example implementation.

    InMemoryStorage can be used for development and testing, however for production a persistent and more secure implementation is required.

    There are solutions available on the Unity Asset Store like SPrefs or Secured PlayerPrefs, that could be considered for use as underlying implementation.

  5. Configure CreatubblesApiClient with instances of IApiConfiguration and ISecureStorage from previous steps.

  6. Use CreatubblesApiClient to create and send requests.

    Examples of using the API client can be found under Assets/Scripts/Demo:

Author

Creatubbles

Contact

In order to receive your AppId and AppSecret please contact us at [email protected].

License

CreatubblesAPIClient is available under the MIT license.