API 인증
사용자 인증에 필요한 내용을 확인합니다.
인증에 필요한 항목
리얼라이즈는 모든 모델을 REST API 형식으로 제공하고 있기 때문에 식별 및 인가를 위한 과정을 필요로합니다.
API인증을 위해서는 다음 3가지 데이터를 필요로 합니다.
service-key
service-key는 API를 호출하는 서비스를 식별하기 위한 서비스별 고유한 식별값이며 서비스의 생성과 함께 자동으로 발급되고 서비스 단위로 관리되기 때문에 각 서비스별 다른 값을 가지고 있습니다.
service-key는 서비스 생성후 서비스 상세페이지에서 확인하실 수 있습니다.
app-key
app-key는 워크스페이스를 식별하기 위한 워크스페이스별 고유의 식별값입니다.
워크스페이스를 식별하기 위한 값이기 때문에 워크스페이스별로 다른 값을 가지고 있으며, 워크스페이스 생성시 자동으로 발급되는 값입니다.
api-token
api-token은 워크스페이스를 인증하기 위해 사용되며, 워크스페이스 단위로 관리되고 동시에 여러개를 생성할 수 있습니다.
발급이나 삭제가 필요한 경우 워크스페이스 콘솔에서 [설정] > [보안] 탭에서 토큰을 관리하실 수 있으며, 보안을 위해 주기적인 토큰 갱신을 권장합니다.
:::highlight yellow ❗
만약 토큰이 외부로 노출되었다면 토큰을 삭제하고 새로운 토큰을 생성해주세요.
:::
인증은 어떻게 진행하나요?
리얼라이즈 API를 호출하기 위해서는 위 3가지 데이터를 Header, PathParemeter에 포함하여 요청을 보내야 합니다.
Header 데이터
api-token
api-token은 API를 호출하기 위한 인증정보로 사용됩니다.
Header의 Authorization 필드의 값으로 Bearer {api-token} 형식으로 포함되어야 합니다.
Path Parameter 데이터
app-key
service-key
app-key
와 service-key
는 각각 워크스페이스와 서비스를 식별하기 위한 식별자로 활용됩니다.
서비스별 API를 호출하는 시점에 요청 URL의 {service-key}
{app-key}
부분을 각각 서비스키와 워크스페이스 키로 변경하여 요청을 보내야 합니다.