본문으로 건너뛰기

소개 ​

Pocket Alert API 문서에 오신 것을 환영합니다. 이 문서에서는 API의 기능을 전반적으로 살펴보고, 시스템과 원활하게 연동하는 방법을 안내합니다. 아래에는 API 요청을 보내기 전에 반드시 필요한 인증 정보를 정리했습니다.

인증 ​

저희 API는 다양한 사용 사례와 선호도에 맞출 수 있도록 두 가지 인증 방식을 지원합니다.

1. JWT 토큰 인증 ​

API 인증 방식을 통해 JWT(JSON Web Token) 토큰을 발급받을 수 있습니다.

JWT 토큰 인증을 시작하려면 이 문서의 뒷부분에서 설명하는 인증 엔드포인트로 요청을 보내세요.

2. 사전 생성 토큰 ​

또는 미리 생성한 토큰을 인증에 사용할 수도 있습니다. 이 토큰은 계정의 API 키 섹션에서 만들고 관리할 수 있습니다. 이 방식을 사용하면 별도의 인증 절차 없이 간편하게 API에 접근할 수 있습니다.

다음 섹션에서는 엔드포인트 설명, 요청/응답 예시, 상태 코드, 오류 메시지 등 API의 세부 내용을 자세히 다룹니다. Pocket Alert와의 원활한 연동이 여기서 시작됩니다!

중요 참고 사항 ​

API에 요청할 때는 필요한 헤더를 반드시 포함해 주세요.

어떤 인증 방식을 사용하셔도 되지만, 서로 다른 서비스와 애플리케이션이 데이터에 접근하는 권한을 구분할 수 있도록 토큰 사용을 권장합니다.

빠른 시작 가이드로 이동 ​

Pocket Alert 문서