介绍

欢迎来到SmartKarrot !查找可以集成到应用程序中的功能和sdk。

1. 使用情况分析
2. App Analytics.
3. 调查和反馈
4. 自定义健康评分
5. 财务数据

有许多不同的api可以用于与SmartKarrot平台集成。但有时很难知道每个API的用途以及何时使用它。本文档解释了可用的api。

最著名的API格式/结构可能是REST API。顾名思义，它使用REST作为API操作的包装器(点对点调用)。可能我们的大部分API流量来自REST API，因为它已经成为跨行业的微服务的事实上的标准。

首先，我们有一系列的api，现在大约有七个。虽然它们都实现了一个相似的目的——从某种意义上说——从你的应用程序(衡量产品和客户成功的用户和事件数据)或从你使用的第三方集成中访问数据，但它们之间有一些关键的差异值得解释。首先，需要注意的是，所有这些api在SmartKarrot上的操作都是相同的。

组成SmartKarrot平台的五个API是:

使用分析

本节中的API是SmartKarrot平台的核心，用于收集用户，设备和事件信息。例如，通过使用这些API，我们会收集有关应用程序用户和设备信息的用户解雇的事件的信息，以便您可以全面地了解您对用户产品的粘性。

应用分析

这些是一组与用户行为相关的默认信息，我们的SDK代表您捕获这些信息。例如，如果你想知道某段时间内用户的平均会话长度，或你的应用页面加载性能，或在过去30秒内访问你的应用的用户，那么我们的SDK就会为你捕获这些分析数据。

调查和反馈

如果您已经集成了我们的调查SDK，那么您可以将调查(多输入问题)和脉冲(单输入问题)发送给您的终端用户或您的客户帐户的关键利益相关者。

自定义运行状况评分

此推送API帮助您为客户发送自定义运行状况评分参数，并为该自定义参数定义评级标准。在某种程度上，你可以选择用SmartKarrot平台上的方法来衡量你的客户。因此，减少你的超负荷学习和行为改变。

财务数据

关于客户的财务信息(ARR, MRR，流失率等)都是衡量客户和产品成功的重要组成部分。所以在SmartKarrot，我们意识到有必要有一个推送API，通过它你可以发送你的客户财务信息，这将帮助你了解每个客户账户的不同财务指标。

选项A: SDK集成

集成SmartKarrot SDK需要以下步骤：

1. 获取你的AppId键。
2. 集成REST API。
3. 添加我们的SDK到您的应用程序。
4. 配置SmartKarrot集成。
5. 配置用户和事件属性。

获取您的Appid.

从SmartKarrot支持团队获取你的应用程序ID(电子邮件:support@smartkarrot.com)。

集成REST API.

获取REST API密钥

从SmartKarrot支持团队获取REST API Key(电子邮件:support@smartkarrot.com)。

API

欢迎使用SmartKarrot API!SmartKarrot为其SaaS服务提供私有REST API。API使得快速配置Web应用程序和直接集成服务器变得更容易。

API支持<一个href="https://en.wikipedia.org/wiki/Cross-origin_resource_sharing">跨源资源共享(CORS)．

URL.

SmartKarrot API可在以下网站获得:

环境	URL.
生产	https://api.smartkarrot.com/v4/

身份验证

SmartKarrot使用带有API密钥的基本认证机制对请求进行认证。例如，如果您的API密钥是daced09f - 8正面- 48 - dc - b1d8 ce3——506204530，你可以用一个简单的HTTP POST请求记录一个事件:

curl -v -u apikey:daced09f-8ade-48dc-b1d8-506204530ce3 -H "Content-Type: application/json" -d '{"appId": "4ed062f1-fc38-4f32-a714-b63dc5399626"，"platform":"iOS"，"deviceId": "53e11019-8034-496b-a484-fa978918873c"，"loginMechanism":" AUTH"，"bundleId": "com.smartkarrot. json"任务年代","lastLoggedInUserId": "f1d0c16d-f9e0-4eb4-8739-45574c43f508","userId": "8f2dfb97-fe4b-49b3-a5d5-a671335cde00","sessionId": "234240-234-234-234-234-234237B891079-A302-4DDD-8860-2672B9682A3B","status": "Active","customerAccountId": "de8327c8-ece7-427a-ba8f-e4c7809ea716"}' 'https://api.smartkarrot.com/v4/usageanalytics/user'

数据类型

SDK使用以下数据类型。

类型	描述
字符串	一个简单的引号字符串，遵循标准JSON规则;看到<一个href="http://json.org/">JSON规范获取详细信息。
整数	一个整数，作为JSON数字传输。
布尔	一个json boolean，字符串true或false。
数组	一个JSON数组。每个元素都包含将被描述的有效负载。
时间戳	中存储的UTC时间<一个href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601格式与毫秒精度。(例如:2018 - 09 - 29 - t09:58:44.635z)
UUID	一个UUID字符串。最好是版本4的UUID。例子:F30CCCC-54A8-49BF-B3E4-6EEE274810AB．
小数	一个十进制值，编码在JSON字符串中。内容将是一串数字，后面跟着一个可选的小数点和其他数字。

创建或更新客户帐户

使用此端点创建新的客户帐户或更新现有帐户。

HTTPS请求

POST / usageanalytics /客户

示例请求

｛“appid”：“4 ed062f1-fc38-4f32-a714-b63dc5399626”，“accountId”：“de8327c8 ece7 - 427 - ba8f e4c7809ea716”，“名称”：“SmartKarrot”，“base64EncodedLogoImage”：“iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJ”，“productId”：“91 ed7505 f106 - 4 - e03 b88b - 63 b76693f391”，“状态”：“活跃”｝

请求体

参数	类型	要求	描述
accountId	字符串	要求	系统中的客户帐户ID(唯一)。
appId	字符串	要求	SmartKarrot App ID。
的名字	字符串	要求	您系统中的客户帐户名称
base64EncodedLogoImage	字符串	可选	Base64编码字符串中的图像。图像尺寸应小于3 MB。
productId	字符串	可选	SmartKarrot产品Id为您的产品。
状态	字符串	要求	枚举:活跃,不活跃的

样例输出

｛“状态”：“成功”｝

身体的反应

记录客户帐户响应。

参数	类型	描述
状态	字符串	枚举成功,错误,INVALID_INPUT

添加我们的SDK到您的应用程序

SmartKarrot提供iOS、Android和Web (JavaScript) sdk。