Partekatu honen bidez:

Push jakinarazpen gailuaren erregistroa aplikazioen garatzaileentzat

  • Artikulua

Push jakinarazpenak konfiguratzeko ikuspegi orokorrari buruz gehiago jakiteko Customer Insights - Journeysn, bisitatu push jakinarazpenen konfigurazioaren ikuspegi orokorra.

Push jakinarazpenak gaitzeko Customer Insights - Journeysn, urrats hauek bete behar dituzu:

  1. Push jakinarazpen aplikazioaren konfigurazioa
  2. Erabiltzaileen mapaketa push jakinarazpenetarako
  3. Push jakinarazpenetarako gailua erregistratzea
  4. Gailuetan push jakinarazpenak jasotzea
  5. Push jakinarazpenetarako interakzioen berri ematea

Diagrama honek barruan gailuak eta erabiltzaileak erregistratzeko beharrezkoak diren bi urratsak deskribatzen ditu Customer Insights - Journeys.

Push jakinarazpenen gailua eta erabiltzaileak erregistratzeko diagrama.

Gailuaren erregistroa

Aplikazio mugikorren konfigurazioa osatzeko, garatzaileak gailuak zerbitzarietan erregistratu behar ditu. Dagoeneko izan beharko zenuke gailuaren tokena, erabiltzailearen IDa Customer Insights - Journeys (kontaktuaren IDa, lead IDa, Customer Insights - Data profilaren IDa) eta mugikorreko aplikazioaren IDa Customer Insights - Journeys.

Gailuaren erregistro-eskaeraren arrakastaz deitzen denean, 202 erantzuna dago. 202 erantzunak eskaera onartu zela adierazten du. Eskaera arrakastatsua berresteko, egoera egiaztatu behar duzu webhook bat erabiliz edo egoera amaierako puntura zuzenean deituz.

APIa

Gailuaren erregistroa (bakarra)

HTTP eskaera adibidea (iOS):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "UserId": "00000000-0000-0000-0000-000000000000",
    "ApiToken": "%API_TOKEN%",
    "ApnsDeviceToken": "%APNS_TOKEN%"
}

HTTP eskaera adibidea (Android):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "UserId": "00000000-0000-0000-0000-000000000000",
    "ApiToken": "%API_TOKEN%",
    "FcmDeviceToken": "%FCM_TOKEN%"
}

Goiburuak:

  • x-ms-track-registration: egia denean, erregistroaren arrakastari/huts egiteari buruzko informazioa gordetzen da eta erregistro-egoeraren APIaren bidez eskuragarri egongo da.
  • x-ms-callback-url: Hutsik ez dagoenean, gailuak huts egin duen edo arrakastatsua den erregistroak POST eskaeraren webhook abiarazten du.
  • x-ms-callback-url-headers: Katetik kate hiztegi baten JSON serializatua dauka, webhook eskaeretarako emandako goiburuak adierazten dituena. x-ms-callback-url definituta dagoenean bakarrik erabiltzen da.

Itzulketak: 202 emandako eskaera baliozkoa bada, 400 bestela.

Erantzunaren gorputza:

x-ms-track-registration egia denean:

{
    "RegistrationRequestId": "%GUID%"
}

Bestela, gorputz hutsa.

Azalpenak
Eman izena Deskribapenak
MobileAppId Customer Insights - Journeysn konfiguratutako mugikorreko aplikazioaren identifikatzailea.
Erabiltzailearen IDa Customer Insights - Data ko kontaktuaren, lead-aren edo Customer Insights - Journeysprofilaren erabiltzailearen identifikatzailea.
ApiToken Zure API tokena eskaera baimentzeko.
ApnsDeviceToken iOS aplikazioak sortutako gailu-token identifikatzaile esklusiboa. Hau iOS gailu baterako bakarrik bidaliko da
FcmDeviceToken Android aplikazioak sortutako gailu-token identifikatzaile esklusiboa. Hau Android gailu baterako bakarrik bidaliko da

Gailuaren erregistroa (anitz)

Batch erregistroaren gorputzak gailuen erregistro-eskaerak adierazten dituen 100 objektuz osaturiko array bat dauka.

HTTP eskaera adibidea (iOS):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/batch

[
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",      
        "UserId": "00000000-0000-0000-0000-000000000000",
        "ApiToken": "%API_TOKEN%",
        "ApnsDeviceToken": "%APNS_TOKEN%"
    },
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",
        "UserId": "00000000-0000-0000-0000-000000000000",
        "ApiToken": "%API_TOKEN%",
        "ApnsDeviceToken": "%APNS_TOKEN%"
    }
]

HTTP eskaera adibidea (Android):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/batch

[
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",      
        "UserId": "00000000-0000-0000-0000-000000000000",
        "ApiToken": "%API_TOKEN%",
        "FcmDeviceToken": "%FCM_TOKEN%"
    },
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",
        "UserId": "00000000-0000-0000-0000-000000000000",
        "ApiToken": "%API_TOKEN%",
        "FcmDeviceToken": "%FCM_TOKEN%"
    }
]

Goiburuak:

  • x-ms-track-registration: egia denean, erregistroaren arrakastari edo huts egiteari buruzko informazioa gordetzen da eta erregistro-egoeraren APIaren bidez eskuragarri egongo da.
  • x-ms-callback-url: hutsik ez dagoenean, gailuak huts egin duen edo arrakastatsua den erregistroak POST eskaera webhook bat abiarazten du.
  • x-ms-callback-url-headers: katetik katearen hiztegi baten JSON serializatua dauka, webhook eskaeretarako emandako goiburuak adierazten dituena. x-ms-callback-url definituta dagoenean soilik erabiltzen da.

Itzulketak: 202 emandako eskaera baliozkoa bada, 400 bestela.

Erantzunaren gorputza:

x-ms-track-registration egia denean: elementu-matrize bat, elementuen ordena bakoitza eskaeraren gorputz-matrizeko ordenari dagokio.

[
    {
        "RegistrationRequestId": "%REG_REQUEST_ID%"
    },
    {
        "RegistrationRequestId": "%REG_REQUEST_ID%"
    }
]

Bestela, gorputz hutsa.

Gailuaren erregistro-egoera

POST  {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/status/

Eskaera organoa:

{
    "RegistrationRequestIds": [
        "%REG_REQUEST_ID%"
    ],
    "MobileAppId": "%MOBILE_APP_ID%",
    "ApiToken": "%API_TOKEN%"
}

Itzulketak: 200 emandako eskaera baliozkoa bada, 400 bestela.

Erantzunaren gorputza - elementu sorta bat:

[
    {
        "Status": "Pending|Success|Failed",
        "FailureReason": " DuplicateExists|DryRunSendingFailed|DeviceTokenTooLong|FailedToStoreDevice|ApiTokenNotValid " // dry run sending is a verification of device token by sending an invisible notification to mobile app. Such sending failure might happen due to a wrong device token or incorrect/expired mobile app auth data
    },
    {
        "Status": "Pending|Success|Failed",
        "FailureReason": " DuplicateExists|DryRunSendingFailed|DeviceTokenTooLong|FailedToStoreDevice|ApiTokenNotValid " // dry run sending is a verification of device token by sending an invisible notification to mobile app. Such sending failure might happen due to a wrong device token or incorrect/expired mobile app auth data
    }
]

Elementu-eskaera bakoitza RegistrationRequestIds matrizearen eskaerari dagokio.

Azalpenak
Eman izena Deskribapenak
Erregistro-eskaeraren IDak Banakako izena emateko eskaera sorta bat. Balioak izena emateko deien erantzunetik hartzen dira. Hau erregistratzeko x-ms-track-registration goiburua erabili denean bakarrik ematen da.
MobileAppId Customer Insights - Journeysn konfiguratutako mugikorreko aplikazioaren identifikatzailea.
Erabiltzailearen IDa Customer Insights - Data ko kontaktuaren, lead-aren edo Customer Insights - Journeysprofilaren erabiltzailearen identifikatzailea.

Garrantzitsua da

Egoera "Zein" egoeran trabatu daitekeen hiru arrazoi posible daude:

  1. Jatorrizko gailua erregistratzeko eskaerak API token baliogabea zuen. Aktore gaiztoek ingurune baten aurkako DoS erasoa egitea saihesteko, "erregistratu gailua" deituz eta mugagabetasun mugagabea sortuz, horrelako saiakerek ez dute erregistro-historia gordetzen. Beraz, ez dago arrakasta egiaztatzeko informaziorik.
  2. CRM-a zorroztutako egoeran egoten da hainbat orduz, eta, ondorioz, egoera eguneratzeko eragiketak bere lana exekutatzen huts egiten du hainbat saiakeraren ondoren.
  3. Gailua erregistratzeko eskaera x-ms-track-registration goibururik eman gabe egin da.

Gailuaren erregistro-egoera webhook

x-ms-status-callback-url an URLa ematen bada gailu baten erregistroa arrakastaz edo huts egiten denean, Customer Insights - Journeys atzitzen du. goiburua.

POST gailua erregistratzeko eskaeraren x-ms-status-callback-url goiburuan emandako URLra.

Mezuaren gorputza:

{ 
    "Status": "Success|Failed", 
    "Signature": "%SIGNATURE%", 
    "FailureReason": " DuplicateExists|DryRunSendingFailed|DeviceTokenTooLong|FailedToStoreDevice|ApiTokenNotValid" 
}

Eskupekoa

Sinadura HMACSHA256 hash-a da API tokena gako gisa erabiliz kalkulatutako dei-itzuleraren URLa. Erabili balioa Customer Insights - Journeys deia egin duela egiaztatzeko. Hash itzultzeko URLa webhook-aren alboko API tokenarekin algoritmo bera erabiliz eta balioak alderatuz.

Oharra

Eskaera bat egiteko saiakera behin gertatzen da. Eskaera bat ez betetzeak jakinarazpena galtzea eragiten du. Hutsegite motak honako hauek dira: deien itzuleraren URL okerra, REST API deien denbora-muga edo ustekabeko erantzunen egoera kodea.

Itzulketak: 202 emandako eskaera baliozkoa bada, 400 bestela.

Espero den gorputza: gorputz hutsa.

Gailuaren garbiketa (bakarra)

Garrantzitsua da datu-basetik baliorik ez duten gailuak kentzea mezuen bidalketa eraginkorra bermatzeko. Erabili hurrengo ikuspegia gailu, erabiltzaile eta aplikazio konbinazio zaharrak gailuen taulatik kentzeko.

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/cleanup

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "ApiToken": "%API_TOKEN%",
    "UserId": "00000000-0000-0000-0000-000000000000",
    "DeviceToken": "%OPTIONAL_FCM_OR_APNS_DEVICE_TOKEN%"
}

Itzulketak: 202 emandako eskaera baliozkoa bada, 400 bestela.

Azalpenak
Eman izena Deskribapenak
MobileAppId Customer Insights - Journeysn konfiguratutako mugikorreko aplikazioaren identifikatzailea.
ApiToken Zure API tokena eskaera baimentzeko.
Erabiltzailearen IDa Customer Insights - Data ko kontaktuaren, lead-aren edo Customer Insights - Journeysprofilaren erabiltzailearen identifikatzailea.
DeviceToken Aplikazioak sortutako gailu-token identifikatzaile esklusiboa.

Gailuaren garbiketa (anitz)

Garrantzitsua da datu-basetik baliorik ez duten gailuak kentzea mezuen bidalketa eraginkorra bermatzeko. Erabili hurrengo ikuspegia gailu, erabiltzaile eta aplikazio konbinazio zaharrak gailuen taulatik kentzeko.

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/cleanup/batch

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "ApiToken": "%API_TOKEN%",
    "UserId": "00000000-0000-0000-0000-000000000000",
    "DeviceToken": "%OPTIONAL_FCM_OR_APNS_DEVICE_TOKEN%"
}

Itzulketak: 202 emandako eskaera baliozkoa bada, 400 bestela.

Azalpenak
Eman izena Deskribapenak
MobileAppId Customer Insights - Journeysn konfiguratutako mugikorreko aplikazioaren identifikatzailea.
ApiToken Zure API tokena eskaera baimentzeko.
Erabiltzailearen IDa Customer Insights - Data ko kontaktuaren, lead-aren edo Customer Insights - Journeysprofilaren erabiltzailearen identifikatzailea.
DeviceTokena Aplikazioak sortutako gailu-token identifikatzaile esklusiboa.