{"id":26275874,"url":"https://github.com/synerise/android-sdk","last_synced_at":"2025-10-13T21:09:23.656Z","repository":{"id":34062432,"uuid":"37848469","full_name":"Synerise/android-sdk","owner":"Synerise","description":"Synerise SDK for Android","archived":false,"fork":false,"pushed_at":"2025-03-04T10:50:36.000Z","size":43097,"stargazers_count":9,"open_issues_count":0,"forks_count":8,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-03-04T11:37:06.838Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Synerise.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-06-22T10:02:56.000Z","updated_at":"2025-03-04T10:50:13.000Z","dependencies_parsed_at":"2023-02-15T10:01:43.887Z","dependency_job_id":"67c03ec8-cf25-4e8e-94a5-6be11b046d62","html_url":"https://github.com/Synerise/android-sdk","commit_stats":null,"previous_names":[],"tags_count":122,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Synerise%2Fandroid-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Synerise%2Fandroid-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Synerise%2Fandroid-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Synerise%2Fandroid-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Synerise","download_url":"https://codeload.github.com/Synerise/android-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243558417,"owners_count":20310574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-14T10:18:36.551Z","updated_at":"2025-10-13T21:09:23.650Z","avatar_url":"https://github.com/Synerise.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Synerise Android SDK (v6.4.0)\n\n[![Platform](https://img.shields.io/badge/platform-Android-orange.svg)](https://github.com/synerise/android-sdk)\n[![Languages](https://img.shields.io/badge/language-Java-orange.svg)](https://github.com/synerise/android-sdk)\n[![GitHub release](https://img.shields.io/github/release/Synerise/android-sdk.svg)](https://github.com/Synerise/android-sdk/releases) \n[![Synerise](https://img.shields.io/badge/www-synerise-green.svg)](https://synerise.com)\n[![Documentation](https://img.shields.io/badge/docs-mobile%20sdk-brightgreen.svg)](https://hub.synerise.com/developers/mobile-sdk/)\n\n---\n\n## About\n[Synerise](https://www.synerise.com) SDK for Android.\n\n## Documentation\nMost up-to-date documentation is available at [Developer Guide - Mobile SDK](https://hub.synerise.com/developers/mobile-sdk).\n\n## Requirements\n* Access to workspace\n* A Profile API Key\n* Minimum Android SDK version - 24\n* Supported targetSdkVersion - 33\n\n## Installation\n\nSet maven path in your root/build.gradle file:\n```\n...\nallprojects {\n    repositories {\n        google()\n        jcenter()\n        maven {  url 'https://pkgs.dev.azure.com/Synerise/AndroidSDK/_packaging/prod/maven/v1' }\n    }\n}\n```\n\nand import dependency:\n```\nbuildscript {\n    repositories {\n        google()\n        jcenter()\n    }\n    dependencies {\n                    classpath 'com.android.tools.build:gradle:3.4.2'\n                    classpath 'com.google.gms:google-services:4.3.3'\n                    classpath 'io.fabric.tools:gradle:1.30.0'\n    }\n}\n```\n\nMoreover, import dependency in your app/build.gradle file and apply plugin:\n```\napply plugin: 'com.android.application'\n```\n```\n...\ndependencies {\n  ...\n  // Synerise Android SDK\n  implementation 'com.synerise.sdk:synerise-mobile-sdk:5.8.0'\n}\n```\n\nFinally, please make sure your `Instant Run` is disabled.\n\n## Initialization\n  \nFirst of all, you need to initialize Synerise Android SDK and provide `Profile API Key`.\n  \nTo get `Profile API Key`, please sign in to your Synerise account and visit [https://app.synerise.com/settings/apikeys](https://app.synerise.com/settings/apikeys).\nThen, generate new `API Key` for `Profile` audience.\n  \n```java\npublic class App extends Application {\n\n    @Override\n    public void onCreate() {\n        super.onCreate();\n\n        initSynerise();\n    }\n\n    private void initSynerise() {\n\n        String syneriseClientApiKey = getString(R.string.synerise_client_api_key);\n        String appId = getString(R.string.app_name);\n\n        final boolean DEBUG_MODE = BuildConfig.DEBUG;\n\n        Synerise.settings.sdk.enabled = true;\n        Synerise.settings.tracker.autoTracking.trackMode = FINE;\n        Synerise.settings.tracker.setMinimumBatchSize(11);\n        Synerise.settings.tracker.setMaximumBatchSize(99);\n        Synerise.settings.tracker.setAutoFlushTimeout(4999);\n        Synerise.settings.injector.automatic = true;\n        Synerise.settings.tracker.locationAutomatic = true;\n\n        Synerise.Builder.with(this, syneriseClientApiKey, appId)\n                        .notificationIcon(R.drawable.notification_icon)\n                        .notificationIconColor(ContextCompat.getColor(this, R.color.amaranth))\n                        .syneriseDebugMode(true)\n                        .crashHandlingEnabled(true)\n                        .pushRegistrationRequired(this)\n                        .locationUpdateRequired(this)\n                        .notificationDefaultChannelId(\"your-channel-id\")\n                        .notificationDefaultChannelName(\"your-channel-name\")\n                        .notificationHighPriorityChannelId(\"your-high-channel-id\")\n                        .notificationHighPriorityChannelName(\"your-high-channel-name\")\n                        .baseUrl(\"http://your-base-url.com/\")\n                        .build();\n\n    }\n}\n```\n\nand in your /values strings file (e.g. `strings.xml`):\n\n```\n\u003cresources\u003e\n\n    \u003cstring name=\"app_name\" translatable=\"false\"\u003eYour GREAT application name\u003c/string\u003e\n    \u003cstring name=\"synerise_client_api_key\" translatable=\"false\"\u003eEF1AD0E0-532B-6AEE-6010-DEDC78F6E155\u003c/string\u003e \u003c!-- replace with valid client api key --\u003e\n\n    ...\n\n\u003c/resources\u003e\n```\n\n## Author\nSynerise, developer@synerise.com. If you need support please feel free to contact us.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynerise%2Fandroid-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsynerise%2Fandroid-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynerise%2Fandroid-sdk/lists"}