Notify Partner API – Swagger‑Style Guide

Public endpoints for device and group messaging. Documented here: GET /link, GET/POST /notify/{deviceId}, and GET/POST /notify-group/{groupId}.

GET

/link

Validate a device or group using id + token

▶

Parameters

⚠️ Rate Limit: This endpoint is limited to 5 calls per minute per IP address.

Name	In	Type	Required	Description
`id`	query	string	required	Device or group ID
`token`	query	string	required	Matching device/group token

Request

GET /link?id=ABC12345&token=XYZ789TOKEN123

Use this for integration tests or setup flows.

cURL

curl "https://notifyapns.pingie.com/link?id=ABC12345&token=XYZ789TOKEN123"

Responses

{
  "success": true,
  "type": "device",
  "device": {
    "id": "ABC12345",
    "name": "iPhone (iOS 17.0)",
    "notification_url": "https://notifyapns.pingie.com/notify/ABC12345",
    "last_active": "2024-12-28T10:30:00Z",
    "platform": "iOS",
    "os_version": "17.0"
  }
}

{
  "success": true,
  "type": "group",
  "group": {
    "id": "GRP56789",
    "name": "Family Notifications",
    "notification_url": "https://notifyapns.pingie.com/notify-group/GRP56789",
    "last_active": "2024-12-28T10:30:00Z",
    "member_count": 3,
    "created_at": "2024-12-01T08:00:00Z"
  }
}

Error: 404 invalid id/token pair • 429 rate limit exceeded (5 calls/minute)

GET

POST

/notify/{deviceId}

Send a notification to a single device

▶

Parameters

ℹ️ Note: Both GET and POST methods are supported with identical parameters.

Name	In	Type	Required	Description
`deviceId`	path	string	required	Target device ID
`token`	query	string	required	Device token
`body`	query	string	required	Notification message. URL‑encode if sent in query/form.

Request Examples

GET Method:

GET /notify/ABC12345?token=XYZ789TOKEN123&body=Hello%20World

POST Method:

POST /notify/ABC12345?token=XYZ789TOKEN123&body=Hello%20World

cURL

Using GET:

curl "https://notifyapns.pingie.com/notify/ABC12345?token=XYZ789TOKEN123&body=Hello%20World"

Using POST:

curl -X POST "https://notifyapns.pingie.com/notify/ABC12345?token=XYZ789TOKEN123&body=Hello%20World"

Responses

{
  "success": true,
  "deviceId": "ABC12345",
  "message": "Notification sent successfully"
}

Errors: 403 invalid device token • 404 device not found

GET

POST

/notify-group/{groupId}

Send a notification to all devices in the group

▶

Parameters

ℹ️ Note: Both GET and POST methods are supported with identical parameters.

Name	In	Type	Required	Description
`groupId`	path	string	required	Target group ID
`token`	query	string	required	Group token
`body`	query	string	required	Notification message. URL‑encode if sent in query/form.

Request Examples

GET Method:

GET /notify-group/GRP56789?token=GROUP_TOKEN&body=Hello%20team!

POST Method:

POST /notify-group/GRP56789?token=GROUP_TOKEN&body=Hello%20team!

cURL

Using GET:

curl "https://notifyapns.pingie.com/notify-group/GRP56789?token=GROUP_TOKEN&body=Hello%20team!"

Using POST:

curl -X POST "https://notifyapns.pingie.com/notify-group/GRP56789?token=GROUP_TOKEN" \
  --data-urlencode "body=Hello team!"

Responses

{
  "success": true,
  "groupId": "GRP56789",
  "message": "Notification sent to 3 devices"
}

Errors: 403 invalid group token • 404 group not found

Tips. URL‑encode body for query/form sends. Both GET and POST methods work for notification endpoints. Keep messages short to avoid truncation. Use GET /link first to verify credentials.