---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API d'installation push

# API d'installation push {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes de lecture

L'API d'installation push fournit des points de terminaison pour enregistrer et désinscrire les jetons qui permettent aux équipements mobiles de recevoir des notifications push d'une application.
Une notification push est un message texte qui apparaît sur l'appareil mobile d'un utilisateur pour l'alerter de quelque chose d'important ou pour lui demander d'effectuer une action.

Lors de la création d'applications mobiles personnalisées, afin de configurer des notifications push, vous devez enregistrer l'appareil auprès du service du fabricant. Le service doit connaître l'adresse de l'appareil d'un utilisateur afin de pouvoir envoyer correctement des notifications à cet appareil à l'aide de jetons push. L'appareil doit également être en mesure de recevoir les notifications et d'agir en conséquence. Pour obtenir des instructions sur l'enregistrement d'un appareil et l'obtention d'un jeton push, consultez la documentation du développeur des systèmes d'exploitation de l'appareil. Par exemple, pour les appareils Apple, reportez-vous à <https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns>.

## Installation push : POST /now/push/{pushApplicationName}/installation {#ariaid-title2}

Ajoute ou met à jour des jetons qui permettent aux appareils de recevoir des notifications push de l'application spécifiée.

### Format d'URL {#push-POST-installation__section_x12_fqg_dmb}

URL versionnée : /api/now/{api_version}/push/{pushApplicationName}/installation

URL par défaut : /api/now/push/{pushApplicationName}/installation

### Paramètres de demande pris en charge

{#push-POST-installation__entry__2}{#push-POST-installation__version-RESTAPI}

| Paramètre | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| pushApplicationName (en anglais seulement) | Nom de l'application pour laquelle enregistrer les notifications push. Ce paramètre doit être identique à la valeur de la colonne Nom de l'application associée dans la table Application push \[sys_push_application\]. Type de données : chaîne |
[Tableau 1. Paramètres de chemin d'accès]

{#push-POST-installation__entry__8}

| Nom | Description |
|-|-|
| Aucun |   |
[Tableau 2. Paramètres de requête]

{#push-POST-installation__entry__12}

| Élément | Description |
|-|-|
| plateforme | Plateforme sur laquelle enregistrer la notification push. Ce paramètre doit être la valeur Nom de la table Plateforme push \[sys_push_platform\]. Type de données : chaîne |
| jeton | Jeton fourni par le fabricant de l'appareil, tel qu'Apple, lorsque l'application mobile s'inscrit pour recevoir des notifications push. Le point de terminaison écrit la valeur du jeton dans la table Installation de notification push \[sys_push_notif_app_install\]. Type de données : chaîne |
[Tableau 3. Paramètres de corps de demande (XML ou JSON)]

### En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#push-POST-installation__entry__18}{#push-POST-installation__content_type-JSON-only-entry-RESTAPI}

| En-tête | Description |
|-|-|
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 4. En-têtes de demandes]

{#push-POST-installation__entry__22}

| En-tête | Description |
|-|-|
| Aucun |   |
[Tableau 5. En-têtes de réponses]

### Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#push-POST-installation__entry__26}{#push-POST-installation__entry-200-status-code}{#push-POST-installation__entry-401-status-code}

| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur de logique s'est produite sur le code côté serveur. |
[Tableau 6. Codes d'état]

### Paramètres du corps de réponse (JSON ou XML)

{#push-POST-installation__entry__36}

| Nom | Description |
|-|-|
| Aucun |   |
[ ]

### Exemple de demande cURL

    curl -X POST \
      https://instance.servicenow.com/api/now/push/ServiceNowPushApp/installation \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{"platform":"Apple","token":"544836d77ac2e551bbf78204630509a7d494fc87f52e85da52e5b5d42910e2cf"}' \

    None

## Installation push : POST /now/push/{pushApplicationName}/removeInstallation {#ariaid-title3}

Désactive les jetons qui permettent aux équipements mobiles de recevoir des notifications push de l'application spécifiée.

### Format d'URL {#push-POST-removeInstallation__section_uy3_drg_dmb}

URL versionnée : /api/now/{api_version}/push/{pushApplicationName}/removeInstallation

URL par défaut : /api/now/push/{pushApplicationName}/removeInstallation

### Paramètres de demande pris en charge

{#push-POST-removeInstallation__entry__2}{#push-POST-removeInstallation__version-RESTAPI}

| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| pushApplicationName (en anglais seulement) | Nom de l'application pour laquelle annuler l'enregistrement des notifications push. Ce paramètre doit être identique à la valeur de la colonne Nom de l'application associée dans la table Application push \[sys_push_application\]. Type de données : chaîne |
[Tableau 7. Paramètres de chemin d'accès]

{#push-POST-removeInstallation__entry__8}

| Nom | Description |
|-|-|
| Aucun |   |
[Tableau 8. Paramètres de requête]

{#push-POST-removeInstallation__entry__12}

| Élément | Description |
|-|-|
| plateforme | Plateforme sur laquelle enregistrer la notification push. Ce paramètre doit être la valeur Nom de la table Plateforme push \[sys_push_platform\]. Type de données : chaîne |
[Tableau 9. Paramètres de corps de demande (XML ou JSON)]

### En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#push-POST-removeInstallation__entry__16}{#push-POST-removeInstallation__content_type-JSON-only-entry-RESTAPI}

| En-tête | Description |
|-|-|
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 10. En-têtes de demandes]

{#push-POST-removeInstallation__entry__20}

| En-tête | Description |
|-|-|
| Aucun |   |
[Tableau 11. En-têtes de réponses]

### Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#push-POST-removeInstallation__entry__24}{#push-POST-removeInstallation__entry-200-status-code}{#push-POST-removeInstallation__entry-401-status-code}

| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur de logique s'est produite sur le code côté serveur. |
[Tableau 12. Codes d'état]

### Paramètres du corps de réponse (JSON ou XML)

{#push-POST-removeInstallation__entry__34}

| Nom | Description |
|-|-|
| Aucun |   |
[ ]

### Exemple de demande cURL

    curl -X POST \
      https://instance.servicenow.com/api/now/push/ServiceNowPushApp/removeInstallation \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{"platform":"Apple"}' \

    None