API OneSignal là gì?

OneSignal là dịch vụ email, sms, thông báo đẩy và tin nhắn trong ứng dụng miễn phí dành cho ứng dụng di động. Plugin này giúp dễ dàng tích hợp ứng dụng Android hoặc Amazon gốc của bạn với OneSignal

Cài đặt

Xem Hướng dẫn thiết lập SDK gốc Android của OneSignal để biết tài liệu

API

Xem trang API SDK gốc Android của OneSignal để biết danh sách tất cả các phương thức khả dụng

Nhật ký thay đổi

Xem các thẻ phát hành của kho lưu trữ này để biết nhật ký thay đổi hoàn chỉnh của mọi phiên bản đã phát hành

Hỗ trợ

Vui lòng truy cập trình theo dõi vấn đề Github của kho lưu trữ này để biết các yêu cầu tính năng và báo cáo lỗi liên quan cụ thể đến SDK. Đối với các vấn đề về tài khoản và hỗ trợ, vui lòng liên hệ với bộ phận hỗ trợ OneSignal từ OneSignal. bảng điều khiển com

OneSignal REST API cho phép các nhà phát triển truy cập chức năng của OneSignal để tích hợp với các trang web và ứng dụng khác. Một số phương pháp API ví dụ bao gồm quản lý thông báo đẩy, quản lý thông tin tài khoản và gửi thông báo đẩy. OneSignal là dịch vụ thông báo đẩy cho các ứng dụng và trang web trên thiết bị di động và web. OneSignal cũng cung cấp nhiều loại SDK

Theo dõi API

  • phiên bản
  • SDK [15]
  • Bài viết [1]
  • Cách thực hiện [0]
  • Mã nguồn [8]
  • Thư viện [1]
  • Nhà phát triển [0]
  • Người theo dõi [22]
  • Nhật ký thay đổi [25]

phiên bản

Bài viết

Làm thế nào để

Mã nguồn

thư viện

Nhà phát triển

Người theo dõi

Nhật ký thay đổi

SDK [15]

Sau đây là danh sách SDK từ thư mục SDK của chúng tôi phù hợp với cụm từ tìm kiếm của bạn. Mặc dù định nghĩa của bạn về SDK có thể khác, nhưng trong thế giới của chúng tôi, chúng tôi xác định SDK là công cụ dành riêng cho nền tảng để sử dụng các API hiện có thuộc loại mà chúng tôi liệt kê trong thư mục API của mình. Ví dụ: SDK Ruby để sử dụng API quảng cáo Twitter. Nếu bạn cho rằng SDK, API hoặc nội dung khác bị thiếu trong thư mục của chúng tôi, hãy nhớ xem các nguyên tắc của chúng tôi để đóng góp cho ProgrammableWeb

OneSignal là một nền tảng tương tác với khách hàng hỗ trợ đẩy di động, đẩy web, email, SMS và tin nhắn trong ứng dụng dành cho nhà phát triển và nhà tiếp thị. Được thiết kế để hỗ trợ giao tiếp, OneSignal cung cấp các công cụ như hành trình của khách hàng, thử nghiệm A/B, phân tích, cá nhân hóa, phân khúc, v.v.

Không có gì bí mật khi thông báo đẩy có thể giúp bạn thu hút và giữ chân người dùng ứng dụng. Trong hướng dẫn này, chúng tôi sẽ chỉ cho bạn cách sử dụng OneSignal REST API bằng NodeJS

Việc sử dụng OneSignal REST API rất hữu ích vì nó có thể giúp bạn tích hợp OneSignal vào các quy trình công việc khác nhau mà ứng dụng của bạn có thể có. OneSignal REST API thân thiện với các công nghệ khác nhau bao gồm cả giao diện người dùng và phụ trợ. Về cơ bản, nếu ngăn xếp công nghệ bạn đang sử dụng vượt trội các lệnh gọi API, thì bạn có thể sử dụng API REST của OneSignal

OneSignal & API đẩy của trình duyệt của bạn

API đẩy cung cấp cho ứng dụng khả năng nhận tin nhắn từ máy chủ cho dù ứng dụng có ở nền trước hay hiện được tải trên tác nhân người dùng hay không. Điều này cho phép bạn gửi thông báo và cập nhật không đồng bộ cho người dùng chọn tham gia, dẫn đến tương tác tốt hơn với nội dung mới kịp thời

Hướng dẫn này sẽ trình bày tổng quan về tham chiếu API OneSignal REST của chúng tôi và cách sử dụng API của chúng tôi với máy chủ NodeJS

Hướng dẫn Tổng quan
  • Phần 1. Tổng quan về OneSignal REST API
  • Tham chiếu API REST
  • Phần 2. Thông báo đẩy trong NodeJS
  • Thiết lập ứng dụng NodeJS
  • Gửi thông báo đẩy
  • Xem thông tin chi tiết về Thông báo

Hướng dẫn này yêu cầu một số kiến ​​thức cơ bản về NodeJS và cách sử dụng API REST. Dưới đây là danh sách các nền tảng mà tôi đang sử dụng

  • Ứng dụng tích hợp OneSignal [di động, web hoặc trò chơi]
  • NPM
  • Tôi đang sử dụng phiên bản NPM v6. 14. 11
  • NodeJS
  • Tôi đang sử dụng NodeJS v16. 14. 2
Phần 1. Tổng quan về OneSignal REST APIGửi thông báo

OneSignal Push API cho phép bạn gửi thông báo đẩy theo chương trình. Thông báo đẩy có thể được gửi đến các thiết bị khác nhau [theo mặc định, bạn gửi chúng đến tất cả Người dùng đã đăng ký] và thậm chí cả các thiết bị cụ thể bằng ID người dùng. Một tính năng thú vị khác của API OneSignal REST là khả năng hủy các thông báo đã được lên lịch

Xem thông báo

Một trong những điểm cuối yêu thích của tôi để sử dụng với OneSignal REST API là điểm cuối thông báo chế độ xem. Điểm cuối này cho phép bạn thu thập thông tin về các thông báo và kết quả liên quan đến chúng. Ví dụ: dữ liệu được trả về có thể cho bạn biết số lượng thông báo chưa được gửi đi, số lượng thông báo đã được gửi, số lượng giao hàng được xác nhận và nhiều thông tin khác. Nếu bạn muốn tìm hiểu thêm về tất cả các điểm cuối này, hãy truy cập tài liệu tham khảo API còn lại của chúng tôi

Phương pháp. BƯU KIỆN

điểm cuối.

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
8

API của chúng tôi có thể làm được nhiều việc hơn là chỉ gửi thông báo và xem dữ liệu từ thông báo đó. Nếu bạn muốn tìm hiểu thêm về toàn bộ API REST của chúng tôi, hãy truy cập trang tổng quan về API REST của OneSignal

Tạo ứng dụng NodeJS của bạn

Bên trong thiết bị đầu cuối của bạn, hãy chạy các lệnh sau để tạo dự án NodeJS mới bằng NPM

npm init

Sau khi nhập lệnh npm trước đó, hãy trả lời tất cả các câu hỏi sẽ xuất hiện trên thiết bị đầu cuối của bạn. Những câu hỏi này sẽ tạo ra các giá trị của

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
0 của bạn

Gói của bạn. json sẽ trông giống như thế này

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
Thiết lập ứng dụng NodeJS của bạn

Điều đầu tiên bạn cần làm là tạo một tệp

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
1. Tệp này sẽ chứa tất cả mã cần thiết để gửi và xem thông báo của bạn

Ở đầu tệp này, thêm gói npm yêu cầu. Gói này sẽ giúp chúng tôi thực hiện lệnh gọi API tới các điểm cuối OneSignal theo cách dễ dàng hơn so với thực hiện với NodeJS nguyên bản

import axios from 'axios';

Bây giờ, hãy chạy

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
2 để thêm gói npm
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
3 vào dự án của bạn. Sau khi bạn đã cài đặt gói NPM
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
3, hãy thêm ba biến sau vào chỉ mục của bạn. js sau khi nhập
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
3

const API_KEY = "YOUR ONE SIGNAL API KEY";
const ONE_SIGNAL_APP_ID = "YOUR ONE SIGNAL APP ID";
const BASE_URL = "//onesignal.com/api/v1";

Để lấy API KEY và APP ID từ OneSignal, hãy điều hướng đến Bảng điều khiển OneSignal và nhấp vào ứng dụng bạn đã tạo bên trong OneSignal. Khi bạn đã chọn ứng dụng mình muốn làm việc, hãy nhấp vào tab S _ settings _

Trên trang này, nhấp vào Khóa và ID

Sao chép ID ứng dụng OneSignal và KHÓA API REST

Ghi chú. Một cách nhanh chóng và dễ dàng khác để truy cập ID ứng dụng OneSignal của bạn là sao chép nó từ URL

Trình tạo tùy chọn

Chức năng này không bắt buộc để sử dụng OneSignal REST API. Chức năng này sẽ chịu trách nhiệm tạo các tùy chọn mà bạn sẽ chuyển đến lệnh gọi API của mình. Đây là một chức năng chung sẽ xây dựng đối tượng JSON dựa trên các tham số mà bạn đã truyền vào

Thông số

  • phương thức @param {chuỗi}
  • @param {chuỗi} đường dẫn
  • @param cơ thể {đối tượng}

trả lại

  • @returns {object} tùy chọn
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
0Tạo thông báo

Tạo thông báo đẩy và gửi cho người dùng ứng dụng của bạn

Phương pháp. BƯU KIỆN

điểm cuối.

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
8

Bộ sưu tập người đưa thư

Để gửi thông báo đẩy, bạn sẽ thêm chức năng sau sẽ thực hiện cuộc gọi đến OneSignal REST API. Hàm này lấy một tham số body đại diện cho thông tin mà thông báo đẩy sẽ chứa

Thông số

  • @param cơ thể {đối tượng}
  • phản hồi @returns {object}
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
1

Đây là một đối tượng cơ thể mẫu

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
2Xem thông báo

Tạo thông báo đẩy và gửi cho người dùng ứng dụng của bạn

Phương pháp. ĐƯỢC

điểm cuối.

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
8

Bộ sưu tập người đưa thư

Để gửi thông báo đẩy, bạn sẽ thêm chức năng sau sẽ thực hiện cuộc gọi đến OneSignal REST API. Hàm này lấy một tham số body đại diện cho thông tin mà thông báo đẩy sẽ chứa

Thông số

  • @param {string} notificationId
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
3Chạy mã của bạn

Ở cuối tệp, thêm các dòng mã sau. Hàm

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
8 đầu tiên sẽ trả về thông tin cơ bản của thông báo khi bạn gửi thông báo đẩy. Tôi đang sử dụng chức năng này để gọi API OneSignal. Như bạn có thể thấy, tôi đang sử dụng tính năng hủy đối tượng để lấy ID thông báo từ đối tượng thông báo được trả về từ
{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
8, ID này sẽ được sử dụng để gọi hàm
import axios from 'axios';
0

{
"name": "myapp",
"version": "1.0.0",
"description": "",
"main": "index.js",
“type”: “module”
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
7

Vui lòng thử nghiệm các điểm cuối API OneSignal REST khác và cho chúng tôi biết suy nghĩ của bạn

Tham gia cộng đồng nhà phát triển OneSignal

Bạn muốn tìm hiểu thêm về các sản phẩm OneSignal và các công nghệ khác?

Cộng đồng Nhà phát triển OneSignal tập hợp trên máy chủ trò chuyện công cộng của chúng tôi, có sẵn trên Discord. Máy chủ Discord của chúng tôi là một môi trường an toàn để kết nối với các thành viên khác, đặt câu hỏi và học hỏi lẫn nhau. Đây cũng là nơi để tương tác với nhóm phát triển sản phẩm OneSignal

Tại sao nên sử dụng OneSignal?

Quan trọng hơn nữa, OneSignal giúp các nhà tiếp thị gửi thông điệp hiệu quả bằng cách cung cấp các công cụ đơn giản và mạnh mẽ để tự động hóa hành trình của khách hàng, phân khúc, cá nhân hóa và sắp xếp thông điệp trên các kênh

Ứng dụng nào sử dụng OneSignal?

Tích hợp vô hạn . Amplitude, Mixpanel, Segment, HubSpot, Shopify, WordPress, and many more.

OneSignal trong phản ứng tự nhiên là gì?

OneSignal là dịch vụ email, sms, thông báo đẩy và tin nhắn trong ứng dụng miễn phí dành cho ứng dụng dành cho thiết bị di động . SDK này giúp bạn dễ dàng tích hợp ứng dụng React-Native iOS và/hoặc Android với OneSignal.

Ứng dụng OneSignal là gì?

Giới thiệu về OneSignal . Nền tảng đa kênh mạnh mẽ của chúng tôi cho phép một triệu doanh nghiệp gửi hơn 10 tỷ tin nhắn hàng ngày. a market-leading customer messaging and engagement solution, offering mobile and web push notifications, in-app messaging, SMS, and email. Our powerful multi-channel platform enables one million businesses to deliver over 10 billion messages daily.

Chủ Đề