Push

Lister les applications push

Paramètres

Réponses

• 200Une page d’applications push, de la plus récente à la plus ancienne.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string	papp_…
  nameobligatoire	string
  apnsobligatoire	object	Les identifiants et l’état de la clé APNs. La clé elle-même n’est jamais renvoyée. Null quand l’application n’a pas de clé APNs. Peut être null
  key_idobligatoire	string	Peut être null
  team_idobligatoire	string	Peut être null
  bundle_idobligatoire	string	Peut être null
  sandbox_statusobligatoire	string	La clé auprès de l’environnement sandbox d’APNs : valid dès qu’un envoi ou une vérification réussit, invalid dès qu’Apple rejette la clé elle-même. Une valeur parmi : unverified | valid | invalid
  production_statusobligatoire	string	La clé auprès de l’environnement de production d’APNs. Une valeur parmi : unverified | valid | invalid
  sandbox_coveredobligatoire	boolean	Si la clé couvrait l’environnement sandbox au téléversement (vérifiée valide, ou Apple n’a pas pu être interrogé). Pour un environnement non couvert, invalid reflète la portée de la clé, pas une défaillance.
  production_coveredobligatoire	boolean	Si la clé couvrait l’environnement de production au téléversement.
  fcmobligatoire	object	Le projet et l’état du compte de service FCM. Le compte de service lui-même n’est jamais renvoyé. Null quand l’application n’en a pas. Peut être null
  project_idobligatoire	string	Peut être null
  statusobligatoire	string	Le compte de service auprès de FCM. Une valeur parmi : unverified | valid | invalid
  webobligatoire	object	Push Web : la paire de clés VAPID de l’application, générée avec l’application ou importée. La clé privée n’est jamais renvoyée. Null pour une application créée avant le push Web qui n’a pas encore de paire. Peut être null
  vapid_public_keyobligatoire	string	La clé publique VAPID (P-256, non compressée, base64url) : passez-la à pushManager.subscribe() comme applicationServerKey.
  subjectobligatoire	string	Le contact fourni aux services push des navigateurs (sujet VAPID) : https://honkio.ca par défaut, ou un mailto: du courriel vérifié du compte, ou une adresse mailto: ou une URL https: sur l’un de ses domaines d’envoi vérifiés. Une notification part avec la valeur par défaut tant que celle qui est définie n’est plus admissible (son domaine a été retiré ou n’est plus vérifié).
  importedobligatoire	boolean	true quand vous avez importé la paire, false quand HonkIO l’a générée.
  created_atobligatoire	string	Le moment où la paire a été générée ou importée. Format : date-time Peut être null
  require_encryptionobligatoire	boolean	true : chaque livraison iOS et Android est chiffrée avec la clé propre à l’appareil, et un appareil enregistré sans encryption_public_key est refusé (ENCRYPTION_KEY_MISSING) : rien ne lui est envoyé en clair et rien n’est facturé. Les navigateurs (web) ne sont jamais refusés pour cette raison : le push Web est toujours chiffré pour le navigateur (RFC 8291). false : les appareils qui ont une clé reçoivent des notifications chiffrées, les autres des notifications en clair.
  placeholder_titleobligatoire	string	Le titre que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  placeholder_bodyobligatoire	string	Le corps que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  created_atobligatoire	string	Format : date-time
  has_moreobligatoire	boolean
  next_cursorobligatoire	string	Passez-le comme cursor pour la page suivante. Null sur la dernière page. Peut être null
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.push.apps.list({ limit: 20 })
if (error) throw new Error(error.message)
for (const app of data.data) console.log(app.id, app.name)

curl https://api.honkio.ca/v1/push/apps \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Créer une application push

Corps de la requête

Réponses

• 201L’application, avec l’état de chaque identifiant.›

  Champ	Type	Description
  idobligatoire	string	papp_…
  nameobligatoire	string
  apnsobligatoire	object	Les identifiants et l’état de la clé APNs. La clé elle-même n’est jamais renvoyée. Null quand l’application n’a pas de clé APNs. Peut être null
  key_idobligatoire	string	Peut être null
  team_idobligatoire	string	Peut être null
  bundle_idobligatoire	string	Peut être null
  sandbox_statusobligatoire	string	La clé auprès de l’environnement sandbox d’APNs : valid dès qu’un envoi ou une vérification réussit, invalid dès qu’Apple rejette la clé elle-même. Une valeur parmi : unverified | valid | invalid
  production_statusobligatoire	string	La clé auprès de l’environnement de production d’APNs. Une valeur parmi : unverified | valid | invalid
  sandbox_coveredobligatoire	boolean	Si la clé couvrait l’environnement sandbox au téléversement (vérifiée valide, ou Apple n’a pas pu être interrogé). Pour un environnement non couvert, invalid reflète la portée de la clé, pas une défaillance.
  production_coveredobligatoire	boolean	Si la clé couvrait l’environnement de production au téléversement.
  fcmobligatoire	object	Le projet et l’état du compte de service FCM. Le compte de service lui-même n’est jamais renvoyé. Null quand l’application n’en a pas. Peut être null
  project_idobligatoire	string	Peut être null
  statusobligatoire	string	Le compte de service auprès de FCM. Une valeur parmi : unverified | valid | invalid
  webobligatoire	object	Push Web : la paire de clés VAPID de l’application, générée avec l’application ou importée. La clé privée n’est jamais renvoyée. Null pour une application créée avant le push Web qui n’a pas encore de paire. Peut être null
  vapid_public_keyobligatoire	string	La clé publique VAPID (P-256, non compressée, base64url) : passez-la à pushManager.subscribe() comme applicationServerKey.
  subjectobligatoire	string	Le contact fourni aux services push des navigateurs (sujet VAPID) : https://honkio.ca par défaut, ou un mailto: du courriel vérifié du compte, ou une adresse mailto: ou une URL https: sur l’un de ses domaines d’envoi vérifiés. Une notification part avec la valeur par défaut tant que celle qui est définie n’est plus admissible (son domaine a été retiré ou n’est plus vérifié).
  importedobligatoire	boolean	true quand vous avez importé la paire, false quand HonkIO l’a générée.
  created_atobligatoire	string	Le moment où la paire a été générée ou importée. Format : date-time Peut être null
  require_encryptionobligatoire	boolean	true : chaque livraison iOS et Android est chiffrée avec la clé propre à l’appareil, et un appareil enregistré sans encryption_public_key est refusé (ENCRYPTION_KEY_MISSING) : rien ne lui est envoyé en clair et rien n’est facturé. Les navigateurs (web) ne sont jamais refusés pour cette raison : le push Web est toujours chiffré pour le navigateur (RFC 8291). false : les appareils qui ont une clé reçoivent des notifications chiffrées, les autres des notifications en clair.
  placeholder_titleobligatoire	string	Le titre que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  placeholder_bodyobligatoire	string	Le corps que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  created_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED : une application push sert au trafic de test comme au trafic réel ; une clé de test peut donc lire les applications et enregistrer des appareils de test, mais ne peut pas créer, modifier ni supprimer d’application. Également FORBIDDEN lorsque la clé n’a pas la permission requise par cette opération, ou que le compte est suspendu ou fermé.Le corps d’erreur standard.
• 409DPA_PUSH_ACCEPTANCE_REQUIRED : le compte a accepté l’entente sur le traitement des renseignements personnels avant qu’elle couvre les notifications push. Acceptez d’abord la version en vigueur dans le tableau de bord (Paramètres, Entente sur le traitement des renseignements personnels). Un compte qui n’a jamais accepté l’entente n’est pas visé.Le corps d’erreur standard.
• 422PUSH_CREDENTIAL_INVALID : Apple ou Google a rejeté l’identifiant (details contient provider, environment et reason), ou VALIDATION_ERROR.Le corps d’erreur standard.
• 429RATE_LIMITED : au plus 20 téléversements et modifications d’identifiants par heure et par compte (création d’une application, ou PATCH comportant apns ou fcm). Retry-After indique quand réessayer.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 503PUSH_PROVIDER_UNAVAILABLE : impossible de joindre Apple ou Google pour vérifier l’identifiant ; rien n’a été enregistré. Réessayez sous peu.Le corps d’erreur standard.

Exemple

const { data: pushApp, error } = await honkio.push.apps.create({
  name: 'Acme mobile',
  apns: {
    keyP8: process.env.APNS_KEY_P8 ?? '',
    keyId: 'ABC123DEFG',
    teamId: 'TEAM123456',
    bundleId: 'ca.acme.app',
  },
  fcm: { serviceAccountJson: process.env.FCM_SERVICE_ACCOUNT_JSON ?? '' },
})
if (error) throw new Error(error.message)
console.log(pushApp.id)

curl -X POST https://api.honkio.ca/v1/push/apps \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Courier"
  }'

Obtenir une application push

Paramètres

Réponses

• 200L’application.›

  Champ	Type	Description
  idobligatoire	string	papp_…
  nameobligatoire	string
  apnsobligatoire	object	Les identifiants et l’état de la clé APNs. La clé elle-même n’est jamais renvoyée. Null quand l’application n’a pas de clé APNs. Peut être null
  key_idobligatoire	string	Peut être null
  team_idobligatoire	string	Peut être null
  bundle_idobligatoire	string	Peut être null
  sandbox_statusobligatoire	string	La clé auprès de l’environnement sandbox d’APNs : valid dès qu’un envoi ou une vérification réussit, invalid dès qu’Apple rejette la clé elle-même. Une valeur parmi : unverified | valid | invalid
  production_statusobligatoire	string	La clé auprès de l’environnement de production d’APNs. Une valeur parmi : unverified | valid | invalid
  sandbox_coveredobligatoire	boolean	Si la clé couvrait l’environnement sandbox au téléversement (vérifiée valide, ou Apple n’a pas pu être interrogé). Pour un environnement non couvert, invalid reflète la portée de la clé, pas une défaillance.
  production_coveredobligatoire	boolean	Si la clé couvrait l’environnement de production au téléversement.
  fcmobligatoire	object	Le projet et l’état du compte de service FCM. Le compte de service lui-même n’est jamais renvoyé. Null quand l’application n’en a pas. Peut être null
  project_idobligatoire	string	Peut être null
  statusobligatoire	string	Le compte de service auprès de FCM. Une valeur parmi : unverified | valid | invalid
  webobligatoire	object	Push Web : la paire de clés VAPID de l’application, générée avec l’application ou importée. La clé privée n’est jamais renvoyée. Null pour une application créée avant le push Web qui n’a pas encore de paire. Peut être null
  vapid_public_keyobligatoire	string	La clé publique VAPID (P-256, non compressée, base64url) : passez-la à pushManager.subscribe() comme applicationServerKey.
  subjectobligatoire	string	Le contact fourni aux services push des navigateurs (sujet VAPID) : https://honkio.ca par défaut, ou un mailto: du courriel vérifié du compte, ou une adresse mailto: ou une URL https: sur l’un de ses domaines d’envoi vérifiés. Une notification part avec la valeur par défaut tant que celle qui est définie n’est plus admissible (son domaine a été retiré ou n’est plus vérifié).
  importedobligatoire	boolean	true quand vous avez importé la paire, false quand HonkIO l’a générée.
  created_atobligatoire	string	Le moment où la paire a été générée ou importée. Format : date-time Peut être null
  require_encryptionobligatoire	boolean	true : chaque livraison iOS et Android est chiffrée avec la clé propre à l’appareil, et un appareil enregistré sans encryption_public_key est refusé (ENCRYPTION_KEY_MISSING) : rien ne lui est envoyé en clair et rien n’est facturé. Les navigateurs (web) ne sont jamais refusés pour cette raison : le push Web est toujours chiffré pour le navigateur (RFC 8291). false : les appareils qui ont une clé reçoivent des notifications chiffrées, les autres des notifications en clair.
  placeholder_titleobligatoire	string	Le titre que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  placeholder_bodyobligatoire	string	Le corps que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  created_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404PUSH_APP_NOT_FOUND : aucune application push avec cet identifiant dans ce compte.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data: pushApp, error } = await honkio.push.apps.get('APP_ID')
if (error) throw new Error(error.message)
console.log(pushApp.name, pushApp.apns?.sandbox_status, pushApp.fcm?.status)

curl https://api.honkio.ca/v1/push/apps/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Mettre à jour une application push

Paramètres

Corps de la requête

Réponses

• 200L’application mise à jour.›

  Champ	Type	Description
  idobligatoire	string	papp_…
  nameobligatoire	string
  apnsobligatoire	object	Les identifiants et l’état de la clé APNs. La clé elle-même n’est jamais renvoyée. Null quand l’application n’a pas de clé APNs. Peut être null
  key_idobligatoire	string	Peut être null
  team_idobligatoire	string	Peut être null
  bundle_idobligatoire	string	Peut être null
  sandbox_statusobligatoire	string	La clé auprès de l’environnement sandbox d’APNs : valid dès qu’un envoi ou une vérification réussit, invalid dès qu’Apple rejette la clé elle-même. Une valeur parmi : unverified | valid | invalid
  production_statusobligatoire	string	La clé auprès de l’environnement de production d’APNs. Une valeur parmi : unverified | valid | invalid
  sandbox_coveredobligatoire	boolean	Si la clé couvrait l’environnement sandbox au téléversement (vérifiée valide, ou Apple n’a pas pu être interrogé). Pour un environnement non couvert, invalid reflète la portée de la clé, pas une défaillance.
  production_coveredobligatoire	boolean	Si la clé couvrait l’environnement de production au téléversement.
  fcmobligatoire	object	Le projet et l’état du compte de service FCM. Le compte de service lui-même n’est jamais renvoyé. Null quand l’application n’en a pas. Peut être null
  project_idobligatoire	string	Peut être null
  statusobligatoire	string	Le compte de service auprès de FCM. Une valeur parmi : unverified | valid | invalid
  webobligatoire	object	Push Web : la paire de clés VAPID de l’application, générée avec l’application ou importée. La clé privée n’est jamais renvoyée. Null pour une application créée avant le push Web qui n’a pas encore de paire. Peut être null
  vapid_public_keyobligatoire	string	La clé publique VAPID (P-256, non compressée, base64url) : passez-la à pushManager.subscribe() comme applicationServerKey.
  subjectobligatoire	string	Le contact fourni aux services push des navigateurs (sujet VAPID) : https://honkio.ca par défaut, ou un mailto: du courriel vérifié du compte, ou une adresse mailto: ou une URL https: sur l’un de ses domaines d’envoi vérifiés. Une notification part avec la valeur par défaut tant que celle qui est définie n’est plus admissible (son domaine a été retiré ou n’est plus vérifié).
  importedobligatoire	boolean	true quand vous avez importé la paire, false quand HonkIO l’a générée.
  created_atobligatoire	string	Le moment où la paire a été générée ou importée. Format : date-time Peut être null
  require_encryptionobligatoire	boolean	true : chaque livraison iOS et Android est chiffrée avec la clé propre à l’appareil, et un appareil enregistré sans encryption_public_key est refusé (ENCRYPTION_KEY_MISSING) : rien ne lui est envoyé en clair et rien n’est facturé. Les navigateurs (web) ne sont jamais refusés pour cette raison : le push Web est toujours chiffré pour le navigateur (RFC 8291). false : les appareils qui ont une clé reçoivent des notifications chiffrées, les autres des notifications en clair.
  placeholder_titleobligatoire	string	Le titre que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  placeholder_bodyobligatoire	string	Le corps que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  created_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED pour une clé de test ; STEP_UP_REQUIRED lorsqu’une session du tableau de bord désactive require_encryption sans confirmation api_keys:elevate ; FORBIDDEN lorsque la clé n’a pas la permission de modification push, ou que le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404PUSH_APP_NOT_FOUND : aucune application push avec cet identifiant dans ce compte.Le corps d’erreur standard.
• 422PUSH_CREDENTIAL_INVALID : Apple ou Google a rejeté l’identifiant (details contient provider, environment et reason), ou VALIDATION_ERROR (y compris un web_push_subject qui n’appartient pas au compte : son courriel vérifié, ou une valeur sur l’un de ses domaines d’envoi vérifiés).Le corps d’erreur standard.
• 429RATE_LIMITED : au plus 20 téléversements et modifications d’identifiants par heure et par compte (création d’une application, ou PATCH comportant apns ou fcm). Retry-After indique quand réessayer.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 503PUSH_PROVIDER_UNAVAILABLE : impossible de joindre Apple ou Google pour vérifier l’identifiant ; rien n’a été enregistré. Réessayez sous peu.Le corps d’erreur standard.

Exemple

// requireEncryption: refuse (and never charge) a device that registered no encryption key.
const { error } = await honkio.push.apps.update('APP_ID', { name: 'Acme mobile (prod)', requireEncryption: true })
if (error) throw new Error(error.message)

curl -X PATCH https://api.honkio.ca/v1/push/apps/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme mobile (prod)",
    "require_encryption": true
  }'

Supprimer une application push

Paramètres

Réponses

• 204Suppression effectuée.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED : une application push sert au trafic de test comme au trafic réel ; une clé de test peut donc lire les applications et enregistrer des appareils de test, mais ne peut pas créer, modifier ni supprimer d’application. Également FORBIDDEN lorsque la clé n’a pas la permission requise par cette opération, ou que le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404PUSH_APP_NOT_FOUND : aucune application push avec cet identifiant dans ce compte.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { error } = await honkio.push.apps.delete('APP_ID')
if (error) throw new Error(error.message)

curl -X DELETE https://api.honkio.ca/v1/push/apps/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Générer ou importer la paire de clés push Web

Paramètres

Corps de la requête

Réponses

• 200L’application, avec sa nouvelle clé publique push Web (web.vapid_public_key). La clé privée n’est jamais renvoyée. Si la clé publique a changé, chaque navigateur enregistré dans l’application (dans les deux modes) a été retiré avec VAPID_KEY_REPLACED, et un seul webhook push_app.vapid_key_replaced indique combien dans chaque mode (aucun push_device.deactivated par navigateur).›

  Champ	Type	Description
  idobligatoire	string	papp_…
  nameobligatoire	string
  apnsobligatoire	object	Les identifiants et l’état de la clé APNs. La clé elle-même n’est jamais renvoyée. Null quand l’application n’a pas de clé APNs. Peut être null
  key_idobligatoire	string	Peut être null
  team_idobligatoire	string	Peut être null
  bundle_idobligatoire	string	Peut être null
  sandbox_statusobligatoire	string	La clé auprès de l’environnement sandbox d’APNs : valid dès qu’un envoi ou une vérification réussit, invalid dès qu’Apple rejette la clé elle-même. Une valeur parmi : unverified | valid | invalid
  production_statusobligatoire	string	La clé auprès de l’environnement de production d’APNs. Une valeur parmi : unverified | valid | invalid
  sandbox_coveredobligatoire	boolean	Si la clé couvrait l’environnement sandbox au téléversement (vérifiée valide, ou Apple n’a pas pu être interrogé). Pour un environnement non couvert, invalid reflète la portée de la clé, pas une défaillance.
  production_coveredobligatoire	boolean	Si la clé couvrait l’environnement de production au téléversement.
  fcmobligatoire	object	Le projet et l’état du compte de service FCM. Le compte de service lui-même n’est jamais renvoyé. Null quand l’application n’en a pas. Peut être null
  project_idobligatoire	string	Peut être null
  statusobligatoire	string	Le compte de service auprès de FCM. Une valeur parmi : unverified | valid | invalid
  webobligatoire	object	Push Web : la paire de clés VAPID de l’application, générée avec l’application ou importée. La clé privée n’est jamais renvoyée. Null pour une application créée avant le push Web qui n’a pas encore de paire. Peut être null
  vapid_public_keyobligatoire	string	La clé publique VAPID (P-256, non compressée, base64url) : passez-la à pushManager.subscribe() comme applicationServerKey.
  subjectobligatoire	string	Le contact fourni aux services push des navigateurs (sujet VAPID) : https://honkio.ca par défaut, ou un mailto: du courriel vérifié du compte, ou une adresse mailto: ou une URL https: sur l’un de ses domaines d’envoi vérifiés. Une notification part avec la valeur par défaut tant que celle qui est définie n’est plus admissible (son domaine a été retiré ou n’est plus vérifié).
  importedobligatoire	boolean	true quand vous avez importé la paire, false quand HonkIO l’a générée.
  created_atobligatoire	string	Le moment où la paire a été générée ou importée. Format : date-time Peut être null
  require_encryptionobligatoire	boolean	true : chaque livraison iOS et Android est chiffrée avec la clé propre à l’appareil, et un appareil enregistré sans encryption_public_key est refusé (ENCRYPTION_KEY_MISSING) : rien ne lui est envoyé en clair et rien n’est facturé. Les navigateurs (web) ne sont jamais refusés pour cette raison : le push Web est toujours chiffré pour le navigateur (RFC 8291). false : les appareils qui ont une clé reçoivent des notifications chiffrées, les autres des notifications en clair.
  placeholder_titleobligatoire	string	Le titre que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  placeholder_bodyobligatoire	string	Le corps que voient Apple et Google sur une notification chiffrée, affiché si l’appareil ne peut pas la déchiffrer. Peut être null
  created_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403LIVE_KEY_REQUIRED pour une clé de test ; STEP_UP_REQUIRED pour une session du tableau de bord sans confirmation api_keys:elevate ; FORBIDDEN lorsque la clé n’a pas la permission de modification push, ou que le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404PUSH_APP_NOT_FOUND : aucune application push avec cet identifiant dans ce compte.Le corps d’erreur standard.
• 422VALIDATION_ERROR : une seule des deux clés, une clé qui n’est pas sur P-256, une clé privée qui ne correspond pas à la clé publique, ou un sujet qui n’est pas une URL https: ou une adresse mailto:, ou qui n’appartient pas au compte (son courriel vérifié, ou une valeur sur l’un de ses domaines d’envoi vérifiés).Le corps d’erreur standard.
• 429RATE_LIMITED : au plus 20 téléversements et modifications d’identifiants par heure et par compte (création d’une application, ou PATCH comportant apns ou fcm). Retry-After indique quand réessayer.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

// No keys: generate a new pair. Both keys: import yours.
const { data: pushApp, error } = await honkio.push.web.setVapidKeys('APP_ID')
if (error) throw new Error(error.message)
console.log(pushApp.web?.vapid_public_key)

curl -X POST https://api.honkio.ca/v1/push/apps/ID/web/vapid-keys \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Lister les appareils enregistrés

Paramètres

Réponses

• 200Une page d’appareils dans le mode de la clé appelante, du plus récent au plus ancien.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string	pdev_…
  app_idobligatoire	string
  user_idobligatoire	string	Votre propre identifiant pour la personne.
  platformobligatoire	string	web désigne l’abonnement push d’un navigateur. Une valeur parmi : ios | android | web
  apns_environmentobligatoire	string	L’environnement APNs d’un appareil iOS ; null pour Android et web. Une valeur parmi : sandbox | production Peut être null
  encryption_key_idobligatoire	string	L’identifiant de la clé de chiffrement que l’appareil a enregistrée (les 16 premiers caractères de base64url(SHA-256(clé publique))), envoyé comme kid dans chaque notification chiffrée pour lui. Null quand il n’en a enregistré aucune, et toujours null pour web. La clé elle-même n’est jamais renvoyée. Peut être null
  activeobligatoire	boolean	false une fois l’appareil retiré ; rien n’est jamais envoyé à un appareil retiré.
  deactivated_reasonobligatoire	string	La raison du retrait : UNREGISTERED ou INVALID_TOKEN (Apple ou Google ; INVALID_TOKEN aussi pour un abonnement de navigateur que son service push ne connaît plus, ou que HonkIO ne peut plus lire), APP_MISMATCH (un jeton d’une autre application, sur un identifiant qui a déjà fonctionné), DEVICE_LIMIT (la limite par utilisateur), APP_DELETED (son application a été supprimée), VAPID_KEY_REPLACED (un navigateur, quand la paire de clés push Web de l’application a été remplacée), VAPID_KEY_MISMATCH (un navigateur dont le service push a refusé la clé de l’application cinq fois de suite sur au moins une journée), DUPLICATE (une deuxième ligne pour le même abonnement de navigateur, laissée par une rotation de clé de chiffrement ; l’autre ligne reste active), DELETED (vous l’avez désinscrit) ou RECIPIENT_DELETED (vous avez supprimé le profil de destinataire de son user_id). Null tant qu’il est actif. Peut être null
  last_seen_atobligatoire	string	Le moment où le jeton a été enregistré pour la dernière fois. Format : date-time
  created_atobligatoire	string	Format : date-time
  has_moreobligatoire	boolean
  next_cursorobligatoire	string	Passez-le comme cursor pour la page suivante. Null sur la dernière page. Peut être null
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.push.devices.list({ userId: 'user_1042' })
if (error) throw new Error(error.message)
for (const device of data.data) console.log(device.id, device.platform, device.active)

curl https://api.honkio.ca/v1/push/devices \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Enregistrer un jeton d’appareil

Corps de la requête

Réponses

• 200L’appareil, enregistré ou rafraîchi.›

  Champ	Type	Description
  idobligatoire	string	pdev_…
  app_idobligatoire	string
  user_idobligatoire	string	Votre propre identifiant pour la personne.
  platformobligatoire	string	web désigne l’abonnement push d’un navigateur. Une valeur parmi : ios | android | web
  apns_environmentobligatoire	string	L’environnement APNs d’un appareil iOS ; null pour Android et web. Une valeur parmi : sandbox | production Peut être null
  encryption_key_idobligatoire	string	L’identifiant de la clé de chiffrement que l’appareil a enregistrée (les 16 premiers caractères de base64url(SHA-256(clé publique))), envoyé comme kid dans chaque notification chiffrée pour lui. Null quand il n’en a enregistré aucune, et toujours null pour web. La clé elle-même n’est jamais renvoyée. Peut être null
  activeobligatoire	boolean	false une fois l’appareil retiré ; rien n’est jamais envoyé à un appareil retiré.
  deactivated_reasonobligatoire	string	La raison du retrait : UNREGISTERED ou INVALID_TOKEN (Apple ou Google ; INVALID_TOKEN aussi pour un abonnement de navigateur que son service push ne connaît plus, ou que HonkIO ne peut plus lire), APP_MISMATCH (un jeton d’une autre application, sur un identifiant qui a déjà fonctionné), DEVICE_LIMIT (la limite par utilisateur), APP_DELETED (son application a été supprimée), VAPID_KEY_REPLACED (un navigateur, quand la paire de clés push Web de l’application a été remplacée), VAPID_KEY_MISMATCH (un navigateur dont le service push a refusé la clé de l’application cinq fois de suite sur au moins une journée), DUPLICATE (une deuxième ligne pour le même abonnement de navigateur, laissée par une rotation de clé de chiffrement ; l’autre ligne reste active), DELETED (vous l’avez désinscrit) ou RECIPIENT_DELETED (vous avez supprimé le profil de destinataire de son user_id). Null tant qu’il est actif. Peut être null
  last_seen_atobligatoire	string	Le moment où le jeton a été enregistré pour la dernière fois. Format : date-time
  created_atobligatoire	string	Format : date-time
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404PUSH_APP_NOT_FOUND : aucune application push avec cet identifiant dans ce compte.Le corps d’erreur standard.
• 409PUSH_DEVICE_LIMIT : l’application a déjà son maximum d’appareils actifs dans ce mode (1 000 000 en production, 1 000 en test).Le corps d’erreur standard.
• 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data: device, error } = await honkio.push.devices.register({
  appId: 'APP_ID',
  token: 'DEVICE_TOKEN',
  platform: 'ios',
  userId: 'user_1042',
  apnsEnvironment: 'production',
  encryptionPublicKey: 'DEVICE_PUBLIC_KEY', // the key the HonkIO push package made on the device
})
if (error) throw new Error(error.message)
console.log(device.id, device.active, device.encryption_key_id)

curl -X PUT https://api.honkio.ca/v1/push/devices \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "papp_0123456789abcdef01234567",
    "platform": "ios",
    "user_id": "user_42"
  }'

Désinscrire un appareil

Paramètres

Réponses

• 204Désinscrit.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404PUSH_DEVICE_NOT_FOUND : aucun appareil avec cet identifiant dans le mode de cette clé.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { error } = await honkio.push.devices.delete('DEVICE_ID')
if (error) throw new Error(error.message)

curl -X DELETE https://api.honkio.ca/v1/push/devices/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Lister les notifications push

Paramètres

Réponses

• 200Une page de notifications push dans le mode de la clé appelante, les plus récentes d’abord, chacune avec accepted_count.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string
  app_idobligatoire	string
  statusobligatoire	string	scheduled : acceptée avec scheduled_at et en attente de ce moment. cancelled : une notification programmée annulée avant son départ ; ce qu’elle avait réservé a été rendu. Une valeur parmi : scheduled | queued | sending | sent | failed | fell_back | cancelled
  toobligatoire	object
  user_idobligatoire	string	Peut être null
  device_idobligatoire	string	Peut être null
  titleobligatoire	string	Peut être null
  bodyobligatoire	string	Peut être null
  dataobligatoire	object	Vaut null une fois purgé. Peut être null
  badgeobligatoire	integer	Peut être null
  soundobligatoire	string	Peut être null
  thread_idobligatoire	string	Peut être null
  ttlobligatoire	integer	Secondes. Peut être null
  priorityobligatoire	string	Une valeur parmi : high | normal Peut être null
  collapse_keyobligatoire	string	Peut être null
  encryptedobligatoire	boolean	Le require_encryption de l’application au moment de l’envoi : true signifie que chaque livraison a été chiffrée ou refusée avec ENCRYPTION_KEY_MISSING. Le champ encrypted de chaque livraison indique ce qu’elle a reçu (false pour un navigateur : le push Web est chiffré pour lui selon la RFC 8291, et non avec une clé d’appareil).
  device_countobligatoire	integer	Les appareils auxquels la notification a été envoyée (et facturée) à la prise en charge ; les appareils refusés faute de clé de chiffrement ne sont pas comptés.
  accepted_count	integer	Les appareils et navigateurs dont le service push (Apple, Google, Mozilla ou Microsoft) a accepté la notification. Dans GET /v1/push et GET /v1/push/{id} ; pas dans la réponse à l’envoi.
  free_countobligatoire	integer	Les livraisons couvertes par l’allocation gratuite mensuelle, déduction faite des remboursements.
  charge_millicentsobligatoire	integer	Le coût exact de la notification, en millicents CAD, déduction faite des remboursements.
  cost_centsobligatoire	integer	Les cents entiers que cette notification a débités du solde.
  fallbackobligatoire	object	Peut être null
  smsobligatoire	object
  toobligatoire	string	Peut être null
  fromobligatoire	string	Peut être null
  bodyobligatoire	string	Peut être null
  fallback_message_idobligatoire	string	Peut être null
  fallback_reasonobligatoire	string	Peut être null
  failure_codeobligatoire	string	Peut être null
  failure_messageobligatoire	string	Peut être null
  body_purged_atobligatoire	string	Format : date-time Peut être null
  livemodeobligatoire	boolean
  sent_atobligatoire	string	Format : date-time Peut être null
  scheduled_atobligatoire	string	Le moment où une notification programmée doit partir (ou devait partir). Null pour une notification envoyée immédiatement. Format : date-time Peut être null
  expires_atobligatoire	string	L’expires_at donné à une notification programmée : l’heure limite de son départ. Null quand aucun n’a été donné, ce qui veut dire scheduled_at plus 24 heures. Une notification qui ne peut pas partir d’ici là échoue avec le failure_code SCHEDULED_SEND_EXPIRED et est remboursée. Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
  deliveries[]	object[]	Le résultat de livraison de chaque appareil. Dans GET /v1/push/{id} seulement.
  idobligatoire	string
  device_idobligatoire	string	Null une fois l’appareil supprimé (30 jours après sa désactivation) ; le résultat de livraison est conservé. Peut être null
  providerobligatoire	string	webpush : le service push d’un navigateur. Une valeur parmi : apns | fcm | webpush
  provider_message_idobligatoire	string	Peut être null
  statusobligatoire	string	Une valeur parmi : pending | accepted | rejected | retrying
  billedobligatoire	boolean
  encryptedobligatoire	boolean	Si elle a été envoyée chiffrée avec la clé propre à l’appareil.
  error_codeobligatoire	string	La raison du rejet, p. ex. DEVICE_TOKEN_INVALID, APP_MISMATCH, CREDENTIAL_INVALID, NO_CREDENTIAL, ENCRYPTION_KEY_MISSING (l’application exige le chiffrement et l’appareil n’a enregistré aucune clé : rien n’est envoyé ni facturé), PAYLOAD_REJECTED ou PROVIDER_ERROR. Peut être null
  attemptsobligatoire	integer
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
  has_moreobligatoire	boolean
  next_cursorobligatoire	string	Passez-le comme cursor pour la page suivante. Null sur la dernière page. Peut être null
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.push.list({ status: 'failed', limit: 20 })
if (error) throw new Error(error.message)
for (const push of data.data) console.log(push.id, push.status)

curl https://api.honkio.ca/v1/push \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Envoyer une notification push

Paramètres

Corps de la requête

Réponses

• 202Réponse par défaut›

  Champ	Type	Description
  id	string
  status	string	scheduled, queued, sending, sent, failed, fell_back ou cancelled. scheduled : acceptée avec scheduled_at et en attente de ce moment ; cancelled : une notification programmée annulée avant son départ, ses frais remboursés.
  scheduled_at	string	Le moment où une notification programmée doit partir (ou devait partir). Null pour une notification envoyée immédiatement. Format : date-time Peut être null
  expires_at	string	L’expires_at donné à une notification programmée : l’heure limite de son départ. Null quand aucun n’a été donné, ce qui veut dire scheduled_at plus 24 heures. Format : date-time Peut être null
  livemode	boolean
  device_count	integer	Les appareils ciblés à la prise en charge.
  collapse_key	string	Envoyé comme apns-collapse-id d’APNs et android.collapse_key de FCM : une notification plus récente avec la même clé remplace une plus ancienne qui n’a pas encore été affichée. Null quand aucune n’a été donnée. Peut être null
  free_count	integer	Les livraisons couvertes par l’allocation gratuite mensuelle, déduction faite des remboursements.
  charge_millicents	integer	Le coût exact de la notification, en millicents CAD (1/1000 de cent) : les livraisons acceptées facturées multipliées par le prix, déduction faite des remboursements des livraisons rejetées.
  cost_cents	integer	Les cents entiers que cette notification a débités du solde, souvent 0 parce que le crédit prépayé est utilisé en premier. Approximatif une fois les livraisons rejetées remboursées (le remboursement rend des millicents à une réserve partagée avec le courriel) ; charge_millicents est le chiffre exact.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 4XXRéponse par défaut
• 5XXRéponse par défaut

Exemple

const { data: push, error } = await honkio.push.send({
  appId: 'APP_ID',
  to: { userId: 'user_1042' },
  title: 'Your code',
  body: '123456',
}, { idempotencyKey: 'login-code-1042-2026-11-03' })
if (error) throw new Error(error.message)
console.log(push.id, push.status, push.device_count)

curl -X POST https://api.honkio.ca/v1/push \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "papp_0123456789abcdef01234567",
    "to": {
      "user_id": "user_42"
    }
  }'

Notifications push gratuites utilisées ce mois-ci

Réponses

• 200L’allocation gratuite du mois et son utilisation.›

  Champ	Type	Description
  monthobligatoire	string	Le mois civil, heure de l’Est : YYYY-MM.
  free_monthlyobligatoire	integer	Livraisons réelles gratuites chaque mois.
  free_usedobligatoire	integer	Livraisons réelles gratuites utilisées ce mois-ci. Toujours 0 pour une clé de test : les envois de test sont gratuits et ne comptent jamais.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.push.usage()
if (error) throw new Error(error.message)
console.log(data)

curl https://api.honkio.ca/v1/push/usage \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Obtenir une notification push par identifiant

Paramètres

Réponses

• 200Réponse par défaut›

  Champ	Type	Description
  id	string
  status	string	scheduled, queued, sending, sent, failed, fell_back ou cancelled. scheduled : acceptée avec scheduled_at et en attente de ce moment ; cancelled : une notification programmée annulée avant son départ, ses frais remboursés.
  scheduled_at	string	Le moment où une notification programmée doit partir (ou devait partir). Null pour une notification envoyée immédiatement. Format : date-time Peut être null
  expires_at	string	L’expires_at donné à une notification programmée : l’heure limite de son départ. Null quand aucun n’a été donné, ce qui veut dire scheduled_at plus 24 heures. Format : date-time Peut être null
  livemode	boolean
  device_count	integer	Les appareils ciblés à la prise en charge.
  collapse_key	string	Envoyé comme apns-collapse-id d’APNs et android.collapse_key de FCM : une notification plus récente avec la même clé remplace une plus ancienne qui n’a pas encore été affichée. Null quand aucune n’a été donnée. Peut être null
  free_count	integer	Les livraisons couvertes par l’allocation gratuite mensuelle, déduction faite des remboursements.
  charge_millicents	integer	Le coût exact de la notification, en millicents CAD (1/1000 de cent) : les livraisons acceptées facturées multipliées par le prix, déduction faite des remboursements des livraisons rejetées.
  cost_cents	integer	Les cents entiers que cette notification a débités du solde, souvent 0 parce que le crédit prépayé est utilisé en premier. Approximatif une fois les livraisons rejetées remboursées (le remboursement rend des millicents à une réserve partagée avec le courriel) ; charge_millicents est le chiffre exact.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 4XXRéponse par défaut

Exemple

const { data: push, error } = await honkio.push.get('PUSH_ID')
if (error) throw new Error(error.message)
for (const delivery of push.deliveries ?? []) console.log(delivery.device_id, delivery.status, delivery.error_code)

curl https://api.honkio.ca/v1/push/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Reprogrammer une notification push programmée

Paramètres

Corps de la requête

Réponses

• 200La nouvelle heure d’envoi de la notification.›

  Champ	Type	Description
  idobligatoire	string
  statusobligatoire	string	Une valeur parmi : scheduled
  scheduled_atobligatoire	string	Format : date-time
  expires_atobligatoire	string	L’expires_at maintenant enregistré, ou null pour scheduled_at plus 24 heures. Format : date-time Peut être null
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND (details.resource "push") : aucune notification push avec cet identifiant dans le mode de la clé appelante.Le corps d’erreur standard.
• 422PUSH_NOT_SCHEDULED (seule une notification scheduled peut être déplacée ; details.current_status indique son état actuel) ou VALIDATION_ERROR (scheduled_at doit être de 1 minute à 30 jours à l’avance ; expires_at de 1 minute à 24 heures après).Le corps d’erreur standard.
• 429PUSH_DAILY_CAP : le jour vers lequel la notification serait déplacée a déjà atteint la limite quotidienne de notifications push. Les détails indiquent la limite et le moment de sa réinitialisation.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 4XXRéponse par défaut

Exemple

const { data, error } = await honkio.push.update('PUSH_ID', { scheduledAt: '2026-10-01T14:00:00Z' })
if (error) throw new Error(error.message)
console.log(data.scheduled_at, data.expires_at) // expires_at: null means scheduled_at plus 24 hours

curl -X PATCH https://api.honkio.ca/v1/push/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduled_at": "2026-10-01T14:00:00Z"
  }'

Annuler une notification push programmée

Paramètres

Réponses

• 204Annulée : les frais remboursés et les livraisons gratuites rendues au mois.
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
• 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND (details.resource "push") : aucune notification push avec cet identifiant dans le mode de la clé appelante.Le corps d’erreur standard.
• 422PUSH_NOT_SCHEDULED : seule une notification scheduled peut être annulée ; details.current_status indique son état actuel.Le corps d’erreur standard.
• 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 4XXRéponse par défaut

Exemple

const { error } = await honkio.push.cancel('PUSH_ID')
if (error) throw new Error(error.message)

curl -X DELETE https://api.honkio.ca/v1/push/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"