Push-Zugangsdaten aktualisieren
post
/apps/push_credential/update
Verwenden Sie diesen Endpunkt, um die Push-Zugangsdaten für eine einzelne App programmatisch zu aktualisieren, sodass Sie Zugangsdaten verwalten können, ohne die Dashboard-UI zu verwenden.
Jede Anfrage aktualisiert die Push-Zugangsdaten für eine App und eine Push-Plattform. Zugangsdaten-Dateien, wie der iOS-Authentifizierungsschlüssel oder das Firebase-Dienstkonto, werden als Base64-kodierte Strings im JSON-Anfragekörper übergeben.
Dieser Endpunkt unterstützt die folgenden Push-Plattformen:
| Plattform |
Zugangsdaten |
| iOS (APNs) |
Nur .p8-Authentifizierungsschlüssel. .p12- und .pem-Zertifikate werden von diesem Endpunkt nicht unterstützt. |
| Android (Firebase Cloud Messaging) |
Dienstkonto-JSON |
| Android (Huawei Mobile Services) |
App-ID und App-Secret |
| Kindle (Amazon Device Messaging) |
Client-ID und Client-Secret |
Voraussetzungen
Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung apps.push_credential.
Anfragekörper
1
2
| Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
|
Fügen Sie pro Anfrage ein Plattform-Objekt ein: apple, firebase, huawei oder kindle.
1
2
3
4
5
6
7
8
9
10
| {
"app_id": (required, string) the app identifier API key found under Settings > App Settings,
"apple": {
"certificate": (required, string) the Base64-encoded .p8 authentication key,
"jwt_key_id": (required, string) the key ID for the .p8 authentication key,
"jwt_team_id": (required, string) your Apple Developer team ID,
"jwt_bundle_id": (required, string) your app's bundle ID,
"apns_gateway": (required, string) either "prod" or "dev"
}
}
|
1
2
3
4
5
6
| {
"app_id": (required, string) the app identifier API key found under Settings > App Settings,
"firebase": {
"credential": (required, string) the Base64-encoded Firebase service account JSON
}
}
|
1
2
3
4
5
6
7
| {
"app_id": (required, string) the app identifier API key found under Settings > App Settings,
"huawei": {
"app_id": (required, string) your Huawei app ID,
"app_secret": (required, string) your Huawei app secret
}
}
|
1
2
3
4
5
6
7
| {
"app_id": (required, string) the app identifier API key found under Settings > App Settings,
"kindle": {
"client_id": (required, string) your Amazon Device Messaging client ID,
"client_secret": (required, string) your Amazon Device Messaging client secret
}
}
|
Anfrageparameter
| Parameter |
Erforderlich |
Datentyp |
Beschreibung |
app_id |
Erforderlich |
String |
Der App-Bezeichner-API-Schlüssel für die App, die Sie aktualisieren möchten. Sie finden ihn im Dashboard unter Einstellungen > App-Einstellungen neben dem Feld API-Schlüssel. |
apple |
Erforderlich* |
Objekt |
Die iOS (APNs)-Zugangsdaten. |
firebase |
Erforderlich* |
Objekt |
Die Android (Firebase Cloud Messaging)-Zugangsdaten. |
huawei |
Erforderlich* |
Objekt |
Die Android (Huawei Mobile Services)-Zugangsdaten. |
kindle |
Erforderlich* |
Objekt |
Die Kindle (Amazon Device Messaging)-Zugangsdaten. |
* Fügen Sie pro Anfrage genau ein Plattform-Objekt ein.
iOS (APNs)-Parameter
| Parameter |
Erforderlich |
Datentyp |
Beschreibung |
certificate |
Erforderlich |
String |
Der Base64-kodierte .p8-Authentifizierungsschlüssel. Es werden nur .p8-Authentifizierungsschlüssel unterstützt; .p12- und .pem-Zertifikate werden von diesem Endpunkt nicht unterstützt. |
jwt_key_id |
Erforderlich |
String |
Die Schlüssel-ID für den .p8-Authentifizierungsschlüssel. |
jwt_team_id |
Erforderlich |
String |
Ihre Apple Developer Team-ID. |
jwt_bundle_id |
Erforderlich |
String |
Die Bundle-ID Ihrer App. |
apns_gateway |
Erforderlich |
String |
Die APNs-Umgebung. Verfügbare Werte sind prod und dev. |
Android (Firebase Cloud Messaging)-Parameter
| Parameter |
Erforderlich |
Datentyp |
Beschreibung |
credential |
Erforderlich |
String |
Das Base64-kodierte Firebase-Dienstkonto-JSON. |
Android (Huawei Mobile Services)-Parameter
| Parameter |
Erforderlich |
Datentyp |
Beschreibung |
app_id |
Erforderlich |
String |
Ihre Huawei-App-ID. |
app_secret |
Erforderlich |
String |
Ihr Huawei-App-Secret. |
Kindle (Amazon Device Messaging)-Parameter
| Parameter |
Erforderlich |
Datentyp |
Beschreibung |
client_id |
Erforderlich |
String |
Ihre Amazon Device Messaging Client-ID. |
client_secret |
Erforderlich |
String |
Ihr Amazon Device Messaging Client-Secret. |
Beispielanfragen
iOS (APNs)
Der Wert apple.certificate muss Base64-kodiert sein, und apple.apns_gateway muss auf prod oder dev gesetzt werden.
1
2
3
4
5
6
7
8
9
10
11
12
13
| curl --location --request POST 'https://rest.iad-01.braze.com/apps/push_credential/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"app_id": "{YOUR_APP_IDENTIFIER}",
"apple": {
"certificate": "{BASE64_ENCODED_STRING}",
"jwt_key_id": "{YOUR_KEY_ID}",
"jwt_team_id": "{YOUR_TEAM_ID}",
"jwt_bundle_id": "{YOUR_BUNDLE_ID}",
"apns_gateway": "prod"
}
}'
|
Android (Firebase Cloud Messaging)
Der Wert firebase.credential muss Base64-kodiert sein.
1
2
3
4
5
6
7
8
9
| curl --location --request POST 'https://rest.iad-01.braze.com/apps/push_credential/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"app_id": "{YOUR_APP_IDENTIFIER}",
"firebase": {
"credential": "{BASE64_ENCODED_STRING}"
}
}'
|
Android (Huawei Mobile Services)
1
2
3
4
5
6
7
8
9
10
| curl --location --request POST 'https://rest.iad-01.braze.com/apps/push_credential/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"app_id": "{YOUR_APP_IDENTIFIER}",
"huawei": {
"app_id": "{YOUR_HUAWEI_APP_ID}",
"app_secret": "{YOUR_HUAWEI_APP_SECRET}"
}
}'
|
Kindle (Amazon Device Messaging)
1
2
3
4
5
6
7
8
9
10
| curl --location --request POST 'https://rest.iad-01.braze.com/apps/push_credential/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"app_id": "{YOUR_APP_IDENTIFIER}",
"kindle": {
"client_id": "{YOUR_ADM_CLIENT_ID}",
"client_secret": "{YOUR_ADM_CLIENT_SECRET}"
}
}'
|
Beispielantwort
Wenn die Zugangsdaten erfolgreich aktualisiert wurden, erhalten Sie eine Antwort mit dem Statuscode 201.
1
2
3
| {
"message": "success"
}
|