푸시 설치 API

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기5분

    • 푸시 설치 API는 모바일 장치가 애플리케이션에서 푸시 알림을 수신할 수 있도록 토큰을 등록 및 등록 취소하는 엔드포인트를 제공합니다.

    푸시 알림은 중요한 것에 대해 경고하거나 작업을 수행하도록 요청하기 위해 사용자의 모바일 장치에 나타나는 문자 메시지입니다.

    사용자 지정 모바일 애플리케이션을 만들 때 푸시 알림을 설정하려면 제조업체의 서비스에 장치를 등록해야 합니다. 서비스는 푸시 토큰을 사용하여 해당 장치에 알림을 올바르게 보낼 수 있도록 사용자 장치의 주소를 알고 있어야 합니다. 또한 장치는 알림을 수신하고 조치를 취할 수 있어야 합니다. 장치를 등록하고 푸시 토큰을 가져오는 방법에 대한 지침은 장치의 운영 체제 개발자 설명서를 참조하세요. 예를 들어, Apple 장치의 경우 을 참조하십시오 https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns.

    밀어넣기 설치 - POST /now/push/{pushApplicationName}/installation

    장치가 지정된 애플리케이션에서 푸시 알림을 수신할 수 있도록 하는 토큰을 추가하거나 업데이트합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/ push/{pushApplicationName}/installation

    기본 URL: / api/now/push/{pushApplicationName}/installation

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    매개변수 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    pushApplicationName 푸시 알림을 등록할 애플리케이션의 이름입니다. 이 매개변수는 푸시 애플리케이션 [sys_push_application] 테이블의 연결된 애플리케이션에 대한 이름 열의 값과 동일해야 합니다.

    데이터 유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    요소 설명
    플랫폼 푸시 알림을 등록할 플랫폼입니다. 이 매개변수는 푸시 플랫폼 [sys_push_platform] 테이블의 이름 값이어야 합니다.

    데이터 유형: 문자열
    토큰 모바일 애플리케이션이 푸시 알림을 수신하도록 등록할 때 Apple과 같은 장치 제조업체에서 제공하는 토큰입니다. 엔드포인트는 푸시 알림 설치[sys_push_notif_app_install] 테이블에 토큰 값을 씁니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 4. 요청 헤더
    헤더 설명
    컨텐츠-형식 요청 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    없음

    샘플 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

    밀어넣기 설치 - POST /now/push/{pushApplicationName}/removeInstallation

    모바일 장치가 지정된 애플리케이션에서 푸시 알림을 수신할 수 있도록 하는 토큰을 비활성화합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/ push/{pushApplicationName}/removeInstallation

    기본 URL: / api/now/push/{pushApplicationName}/removeInstallation

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    pushApplicationName 푸시 알림 등록을 취소할 애플리케이션의 이름입니다. 이 매개변수는 푸시 애플리케이션 [sys_push_application] 테이블의 연결된 애플리케이션에 대한 이름 열의 값과 동일해야 합니다.

    데이터 유형: 문자열
    표 8. 쿼리 매개변수
    이름 설명
    없음
    표 9. 요청 본문 매개변수(XML 또는 JSON)
    요소 설명
    플랫폼 푸시 알림을 등록할 플랫폼입니다. 이 매개변수는 푸시 플랫폼 [sys_push_platform] 테이블의 이름 값이어야 합니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 10. 요청 헤더
    헤더 설명
    컨텐츠-형식 요청 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 12. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    없음

    샘플 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