{"id":19900651,"url":"https://github.com/microcmsio/microcms-android-sdk","last_synced_at":"2025-05-02T23:31:10.394Z","repository":{"id":45654578,"uuid":"352471124","full_name":"microcmsio/microcms-android-sdk","owner":"microcmsio","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-02T03:21:20.000Z","size":174,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-01T01:53:05.666Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microcmsio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-29T00:29:10.000Z","updated_at":"2022-12-03T13:33:30.000Z","dependencies_parsed_at":"2022-09-06T07:10:36.405Z","dependency_job_id":null,"html_url":"https://github.com/microcmsio/microcms-android-sdk","commit_stats":null,"previous_names":["wantainc/microcms-android-sdk"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-android-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-android-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-android-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-android-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microcmsio","download_url":"https://codeload.github.com/microcmsio/microcms-android-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252122225,"owners_count":21698305,"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":"2024-11-12T20:12:51.920Z","updated_at":"2025-05-02T23:31:09.922Z","avatar_url":"https://github.com/microcmsio.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# microCMS Android SDK\n\nIt helps you to use microCMS from Android(Kotlin) applications.\nCheck [the official documentation](https://document.microcms.io/tutorial/android/android-top) for more information\n\n## Getting Started\n\n### Installation\n\nThe library is located in maven central.\n\n```gradle\nbuildscript {\n    repositories {\n        mavenCentral() //need this line\n    }\n}\n```\n\nInstall dependency:\n\n```gradle\ndependencies {\n    implementation 'io.microcms:android-sdk:1.0.1'\n}\n```\n\nAnd you need to get `android.permission.INTERNET` permission in the manifest:\n\n```xml\n\u003cuses-permission android:name=\"android.permission.INTERNET\" /\u003e\n```\n\n### How to use\n\nFirst, create a client.\n\n```kotlin\nval client = Client(\n  serviceDomain = \"YOUR_DOMAIN\", //YOUR_DOMAIN is the XXXX part of XXXX.microcms.io\n  apiKey = \"YOUR_API_KEY\",\n)\n```\n\nNext, you can call some api like below.\n`result`(`Result\u003cJSONObject\u003e`) is a instance of [kotlin standard class](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/).\n\n### Get content list\n\n```kotlin\nclient.get(\n        \"API_ENDPOINT\"\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getJSONArray(\"contents\").toString(2)) }\n}\n```\n\n### Get content list with parameters\n\n```kotlin\nclient.get(\n        \"API_ENDPOINT\",\n        listOf(Limit(2), Filters(\"createdAt[greater_than]2021\")) //some params\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getJSONArray(\"contents\").toString(2)) }\n}\n```\n\n### Get single content\n\n```kotlin\nclient.get(\n        \"API_ENDPOINT\",\n        \"CONTENT_ID\",\n        listOf(Fields(\"id\")) //some params\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n\n### Get object form content\n\n```kotlin\nclient.get(\n        \"API_ENDPOINT\",\n        listOf(Fields(\"id\")) //some params\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n\n### Create content\n\n```kotlin\nclient.create(\n        \"API_ENDPOINT\",\n        null,\n        mapOf(\"text\" to  \"Hello Android SDK!\"),\n        false\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n\n### Create content with specified ID\n\n```kotlin\nclient.create(\n        \"API_ENDPOINT\",\n        \"CONTENT_ID\",\n        mapOf(\"text\" to  \"Hello Android SDK!\"),\n        false\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n\n### Create draft content\n\n```kotlin\nclient.create(\n        \"API_ENDPOINT\",\n        \"CONTENT_ID\",\n        mapOf(\"text\" to  \"Hello Android SDK!\"),\n        true\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n\n### Update content\n\n```kotlin\nclient.update(\n        \"API_ENDPOINT\",\n        \"CONTENT_ID\",\n        mapOf(\"text\" to \"Hello Android SDK update method!\")\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n\n### Update object form content\n\n```kotlin\nclient.update(\n        \"API_ENDPOINT\",\n        null,\n        mapOf(\"message\" to \"Hello Android SDK!\")\n) { result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n\n### Delete content\n\n```kotlin\nclient.delete(\n        \"API_ENDPOINT\",\n        \"CONTENT_ID\")\n{ result -\u003e\n    result.onSuccess { json -\u003e Log.d(\"microCMS example\", json.getString(\"publishedAt\")) }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrocmsio%2Fmicrocms-android-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrocmsio%2Fmicrocms-android-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrocmsio%2Fmicrocms-android-sdk/lists"}