如何获取jiguang API开放平台密钥(分步指南)

在当今的数字化时代，无论是数字媒体内容的丰富性、软件开发的创新性，还是日常生活的便捷性，集成高效、可靠的第三方服务都成为了提升用户体验的关键一环。Jiguang（极光）API开放平台正是这样一个提供多样化服务的平台，其在推送通知、短信验证、统计分析等多个领域拥有强大的功能，为开发者提供了极大的便利。特别是在需要实现即时通讯、用户行为分析等功能的场景中，Jiguang API的作用尤为突出。本文将详细指导你如何获取Jiguang API开放平台的密钥，通过分步骤的操作，帮助你轻松完成这一关键步骤，为后续的开发和集成工作打下坚实的基础。接下来，让我们一起踏上获取Jiguang API密钥的旅程。

1. 登录/注册极光开放平台

2. 创建应用

1.进入工作台点击创建应用

2.填写应用信息

3.填写配置信息

3. 获取密钥

1.进入应用列表，选择刚刚创建的应用

2.复制AppKey

4. 鉴权

极光 REST API 采用 HTTP 基本认证的验证方式。

基本做法为，HTTP Header（头）里加 Authorization：

Authorization: Basic ${base64_auth_string}

鉴权举例

你的 appKey 是 “7d431e42dfa6a6d693ac2d04”, masterSecret 是 “5e987ac6d2e04d95a9d8f0d1″，则调用 Push API v3 时，使用 curl 命令调用如下：

curl --insecure -X POST -v https://api.jpush.cn/v3/push -H "Content-Type: application/json"

-u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

-d  '{"platform":"all","audience":"all","notification":{"alert":"Hi,JPush!"}}'

HTTP 请求发出的请求是：

> POST /v3/push HTTP/1.1

> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

5. 发送请求

调用地址

https://api.jpush.cn/v3/push

调用验证

详情参见 REST API 概述的鉴权方式说明。

请求示例

请求头

> POST /v3/push HTTP/1.1

> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

请求体

{

    "platform": "all",

    "audience": {

        "tag": [

            "深圳",

            "北京"

        ]

    },

    "notification": {

        "alert": "Hello, {{content}}！",

        "android": {

            "alert": "Hi, JPush!",

            "title": "Send to Android",

            "builder_id": 1,

            "large_icon": "http://www.jiguang.cn/largeIcon.jpg",

            "intent": {

                "url": "intent:#Intent;component=com.jiguang.push/com.example.jpushdemo.SettingActivity;end"

            },

            "extras": {

                "newsid": 321

            }

        },

        "ios": {

            "alert": "Hi, JPush!",

            "sound": "default",

            "badge": "+1",

            "thread-id": "default",

            "extras": {

                "newsid": 321

            }

        },

        "hmos" : {

            "alert":"hmos alert",

            "title":"hmos titile",

            "intent": {

                "url":"scheme://test?key1=val1&key2=val2"

            },

            "badge_add_num":1,

            "badge_set_num":1,

            "extras": {

                "age":18

            },

            "category":"IM",

            "test_message":false,

            "receipt_id":"abc1212",

            "large_icon":"https://www.jiguang.cn/largeIcon.jpg",

            "style":0,

            "push_type": 0

        },

        "voip": { // 此功能需要 JPush iOS SDK v3.3.2 及以上版本支持

            "key": "value" // 任意自定义 key/value 对，api 透传下去

        },

        "quickapp": {

            "alert": "Hi, JPush!",

            "title": "Send to QuickApp",

            "page": "/page1"

        }

    },

    "message": {

        "msg_content": "Hi,JPush",

        "content_type": "text",

        "title": "msg",

        "extras": {

            "key": "value"

        }

    },

    "sms_message": {

        "temp_id": 1250,

        "temp_para": {

            "code": "123456"

        },

        "delay_time": 3600,

        "active_filter": false

    },

    "options": {

        "time_to_live": 60,

        "apns_production": false,

        "apns_collapse_id": "jiguang_test_201706011100"

    },

    "callback": {

        "url": "http://www.bilibili.com",

        "params": {

            "name": "joe",

            "age": 26

        },

        "type": 3

    },

    "cid": "8103a4c628a0b98974ec1949-711261d4-5f17-4d2f-a855-5e5a8909b26e"

}

推送参数

推送的参数结构体，注意部分参数不能同时使用，详见下表：

关键字	选项	含义
platform	必填	推送平台设置
audience	必填	推送设备指定
notification	可选	通知内容体,是被推送到客户端的内容。与 message 一起二者必须有其一，可以二者并存。
message	可选	消息内容体,是被推送到客户端的内容。与 notification 一起二者必须有其一，可以二者并存。
inapp_message	可选	面向于通知栏消息类型，需搭配notification参数一起使用，对于通知权限关闭的用户可设置启用此功能。不可与 message 同时并存。
live_activity	可选	实时活动内容体。不可与 notification 或 message 等并存。
sms_message	可选	短信渠道补充送达内容体
options	可选	推送参数
callback	可选	回调参数
notification_3rd	可选	自定义消息转厂商通知内容体。与 message 一起使用。
cid	可选	用于防止 api 调用端重试造成服务端的重复推送而定义的一个标识符，获取方法详见高级功能 API。

6. 常见问题

Q：如何找到jiguang API开放平台

A：幂简集成是国内领先的API集成管理平台，专注于为开发者提供全面、高效、易用的API集成解决方案。幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’jiguang API开放平台‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。

Q：如何获取客户端日志？
A：如果集成有报错，需要获取客户端日志时，请按照客户端日志获取方法获取日志进行初步排查，若按照报错提示仍无法解决问题，可以提供日志给技术支持进行排查。

Q：为什么打开应用能收到推送，杀死应用收不到推送？
A：先检查是否成功集成厂商通道，再通过排查工具消息查询进行生命周期查询，排查详情参考离线无法收到推送。

Q：为什么标签、别名设置失败？
A：标签和别名有绑定时效和个数限制，详情参考标签/别名设置相关问题进行排查。

启用 YouTube Data API 的项目默认每天分配 10,000 个单元的配额，这个配额足以满足绝大多数 API 用户的需求。默认配额可能会发生变化，可帮助我们优化配额分配，并以对 API 用户更有意义的方式扩缩我们的基础架构。您可以在 API 控制台的配额页面上查看您的配额使用情况。

Q：如何设置自定义铃声？
A：目前仅极光通道和部分厂商通道支持自定义铃声，详情参见自定义铃声设置。

Q：如何设置通知栏图片？

A：极光推送支持大图片、右侧图标、状态栏小图标设置，详情参见图标设置。

Q：jiguang API开放平台的替代品有哪些？

除了jiguang API开放平台，还有其他替代服务商也提供类似api服务，例如：

Opt-Intelligence API开放平台、triplewhale API开放平台、messagebird API开放平台

更多竞品可以在幂简集成开放平台中找到。

Q：jiguang API开放平台这个密钥还适用于哪些api？

统计 API、回执 API、定时推送任务 API

7. 总结

本文全面且细致地介绍了如何获取Jiguang API开放平台密钥的分步指南，为开发者们提供了一份条理清晰、操作简便的实用手册。从Jiguang API平台的账号注册，到完成开发者身份认证，再到最终成功获取密钥，每一步操作都配以详尽的说明与指导，确保开发者能够轻松、准确地完成整个流程。获取密钥只是利用Jiguang API的第一步，如何高效、稳定地集成并应用这些强大的推送通知、短信验证、统计分析等功能才是关键。因此，在本文中，我们不仅指导了如何获取密钥，还隐含地强调了获取后进行初步测试与验证的重要性。通过测试，开发者可以确保Jiguang API能够顺利集成到应用中，并发挥出最佳效果，从而提升应用的性能和用户体验。本文为开发者们提供了一个全面、详尽且极具实用性的操作指南，帮助他们顺利获取Jiguang API开放平台的密钥，并将这一强大的服务能力高效地集成到应用中。我们相信，随着开发者们对这一指南的深入理解和实践，将能够在即时通讯、用户行为分析等领域取得更加显著的成果，为应用的创新与发展注入新的活力。