https://github.com/1312inc/webasyst-x-android-library

Handles user authorization via Webasyst ID, stores and refreshes API tokens, provides the basic layer for working with any custom Webasyst apps APIs.
https://github.com/1312inc/webasyst-x-android-library

android-library maven webasyst

Last synced: 13 days ago
JSON representation

Handles user authorization via Webasyst ID, stores and refreshes API tokens, provides the basic layer for working with any custom Webasyst apps APIs.

• Host: GitHub
• URL: https://github.com/1312inc/webasyst-x-android-library
• Owner: 1312inc
• License: lgpl-3.0
• Created: 2021-02-17T07:15:30.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T13:50:49.000Z (10 months ago)
• Last Synced: 2025-01-13T15:15:53.304Z (13 days ago)
• Topics: android-library, maven, webasyst
• Language: Kotlin
• Homepage:
• Size: 246 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Webasyst-X-Android-Library

## Creating new Webasyst Android client app

### Starting from template

Boilerplate demo app using this Webasyst library is available here: **https://github.com/1312inc/Webasyst-X-Android**

### Starting from scratch

1. Add dependencies

In your application module

```groovy

repositories {

    // Make sure maven central repository is enabled

    mavenCentral()

    // ...

}

dependencies {

    // Library version to use

    def webasyst_version = '1.1.1'

    // Authentication module. Used in log in process and into the process of merging WAID profiles.

    implementation "com.webasyst:auth-kt:$webasyst_version"

    // Webasyst ID (WAID) api client

    implementation "com.webasyst:waid:$webasyst_version"

    // Webasyst client - used to retrieve basic installation data

    implementation "com.webasyst:webasyst:$webasyst_version"

    // Installer client - used to install products

    implementation "com.webasyst:app-installer:$webasyst_version"

    // Required application-specific modules

    implementation "com.webasyst:app-blog:$webasyst_version"

    implementation "com.webasyst:app-shop:$webasyst_version"

    implementation "com.webasyst:app-site:$webasyst_version"

}

```

2. In your app's `AndroidManifest.xml`, in `application` section, add authentication redirect activity.

Note the comment on `

  

    

    

    

    

    

  

```

3. Configure Webasyst ID (WAID) authentication sevice. This should be done once, preferably early in application's lifecycle. The recommended option is to extend `Application` class and do configuration in it's `onCreate()` method.

See `WebasystAuthService.configure()` for details. For Kotlin, use `configureWebasystAuth()`

4. Implement Authentication Activity.

The easiest way to do it is to extend your Activity from `WebasystAuthActivity` and call it's `waSignIn()` from your SignIn button's `onClick()` callback.

If that's not an option (eg. your Activity is an extension of some other activity) you can use WebasystAuthHelper directly. See `WebasystAuthActivity`'s code for details.

5. Use Webasyst ID (WAID) API methods

Create an instance of the `WAIDClient` to use API methods. Please refer to the [official Webasyst documentation](https://developers.webasyst.com/docs/features/webasyst-id-auth/resources-server-api/)

Get your Webasyst ID auth client id here: https://www.webasyst.com/my/waid/apps/

6. You are good to go.