|
3 | 3 | ## Creatubbles API Client Unity SDK
|
4 | 4 | Creatubbles API Client Unity SDK is a simple library built to help you communicate with the latest [Creatubbles API](https://stateoftheart.creatubbles.com/api/).
|
5 | 5 |
|
6 |
| -Current SDK version: 0.1 |
7 |
| -Supported Unity versions: 5.4.x and newer |
8 |
| -Supported platforms: iOS, macOS (and possibly others, not yet confirmed) |
| 6 | +Current SDK version: `0.1` |
| 7 | +Supported Unity versions: `5.4.x` and newer |
| 8 | +Supported output platforms: `iOS`, `macOS` (and possibly others, not yet confirmed) |
9 | 9 |
|
10 |
| -Please note that library is still under development, and the SDK API is subject to change. |
| 10 | +Please note that library is still under development, and the SDK API might change in next versions. |
11 | 11 |
|
12 | 12 | ## Documentation
|
13 |
| -SDK API reference can be found in `Docs/reference/html/index.html` under repository main directory. |
| 13 | +SDK API reference (Doxygen generated) is available under `Docs/reference/html/` as `index.html`. |
14 | 14 |
|
15 | 15 | ## Installation
|
16 |
| -### TODO |
| 16 | +Copy `Assets/Scripts/Creatubbles` to you project's `Assets/Scripts` folder. |
17 | 17 |
|
18 | 18 | ## QuickStart
|
19 |
| -### TODO |
| 19 | +1. Contact us at <[email protected]> to obtain application ID and secret. |
| 20 | + |
| 21 | +2. Implement [IApiConfiguration](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/IApiConfiguration.cs) including your application ID and secret. |
| 22 | + |
| 23 | + See [CreatubblesConfiguration](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Demo/CreatubblesConfiguration.cs) for example implementation. |
| 24 | + |
| 25 | +3. SDK project contains a demo scene `CreatubblesDemo`, which can be used to check how the SDK is working. |
| 26 | + |
| 27 | +4. Implement [ISecureStorage](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/Storage/ISecureStorage.cs). |
| 28 | + |
| 29 | + See [InMemoryStorage](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/Storage/InMemoryStorage.cs) for example implementation. |
| 30 | + |
| 31 | + [InMemoryStorage](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/Storage/InMemoryStorage.cs) can be used for **development and testing**, however for **production** a persistent and more secure implementation is required. |
| 32 | + |
| 33 | + There are solutions available on the Unity Asset Store like [SPrefs](https://www.assetstore.unity3d.com/en/#!/content/56051) or [Secured PlayerPrefs](https://www.assetstore.unity3d.com/en/#!/content/32357), that could be considered for use as underlying implementation. |
| 34 | + |
| 35 | +5. Configure [CreatubblesApiClient](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/CreatubblesApiClient) with instances of [IApiConfiguration](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/IApiConfiguration.cs) and [ISecureStorage](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/Storage/ISecureStorage.cs) from previous steps. |
| 36 | + |
| 37 | +6. Use [CreatubblesApiClient](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Creatubbles/Api/CreatubblesApiClient) to create and send requests. |
| 38 | + |
| 39 | + Examples of using the API client can be found under `Assets/Scripts/Demo`: |
| 40 | + * [Logging in](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Demo/LogInDemo.cs) |
| 41 | + * [Getting landing URLs](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Demo/LandingUrlsDemo.cs) |
| 42 | + * [Creation upload](https://github.com/creatubbles/ctb-api-unity/blob/master/Assets/Scripts/Demo/UploadDemo.cs) |
20 | 43 |
|
21 | 44 | ## Author
|
22 | 45 | [Creatubbles](https://www.creatubbles.com/)
|
|
0 commit comments