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開放平臺的密鑰,并將這一強大的服務能力高效地集成到應用中。我們相信,隨著開發者們對這一指南的深入理解和實踐,將能夠在即時通訊、用戶行為分析等領域取得更加顯著的成果,為應用的創新與發展注入新的活力。

上一篇:

微信支付 API開放平臺訪問token分步指南

下一篇:

如何獲取revai 開放平臺 API Key 密鑰(分步指南)
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費