Petnow SDK 개요

Petnow SDK Usage scenario

Petnow SDK란?

Petnow SDK는 반려동물 생체 정보 검증/식별 기능을 모바일 앱에 손쉽게 통합할 수 있도록 하는 프레임워크입니다.

핵심 기능

강아지/고양이 고유 생체정보 추출: 고성능 on-device AI를 이용한 생체 정보 추출
생체정보 검증/식별: 생체정보를 이용한 반려동물 인증
실시간 가이드: 최적의 촬영을 위한 시각적 피드백

이런 분들에게 필요합니다

반려동물 등록/인증 기능을 앱에 추가하려는 개발자
기존 앱의 반려동물 검증/식별 정확도를 높이고 싶은 팀
B2B 서비스로 반려동물 생체 정보 검증/식별을 제공하려는 사업자

SDK 구조

Petnow 모바일 SDK는 온디바이스 촬영 UI를 제공하고, 서버 통신(이미지 업로드·등록·검증/식별)은 고객사 앱 서버가 Petnow 서버 REST API를 호출해 처리합니다.

모듈 설명

UI Module

카메라 UI와 생체 정보 추출을 담당하며, 고객사 앱에 통합되는 모바일 모듈입니다.

기능: 실시간 탐지, 진행률 표시, 오버레이 가이드, 촬영 이미지 파일 반환
의존성: Camera Module(내부)

Camera Module

생체 정보 추출 엔진 (내부 모듈, 직접 사용 불가)

기능: ML 추론, 이미지 처리, 품질 검사

이미지 업로드·반려동물 등록/관리·검증/식별은 모바일 SDK가 아니라 고객사 앱 서버가 Petnow 서버 REST API를 호출해 처리합니다. 앱 서버가 호출에 쓰는 키(x-petnow-api-key)는 서버에만 두세요. SDK는 기기에서 쓸 키가 따로 필요하므로, 서버용 키를 넣지 말고 앱 전용 키를 별도로 발급하세요 — 플랫폼별 가이드의 API 키 보안 절을 참고하세요.

일반적인 사용 흐름

촬영 품질은 어떻게 판정되나요

카메라 SDK는 프레임을 사용할지 여부를 기기에서 결정합니다. 기준에 못 미치면 실패 사유를 탐지 상태로 알려주므로, 앱이 사용자에게 무엇을 바꿔야 하는지 안내할 수 있습니다. 판정은 기기에서 이뤄집니다. 카메라가 열린 뒤에는 촬영이 네트워크를 기다리지 않습니다.

네트워크가 필요한 단계:

단계	네트워크	비고
`initializeCamera()` — 라이선스 검증	필요, 프로세스당 API 키별 1회	SDK가 서버에 키를 검증합니다. 키가 거절되거나 서버에 도달할 수 없으면 `InvalidLicense`로 실패하고 카메라가 열리지 않습니다. 같은 프로세스에서 이미 검증된 키는 다시 검증하지 않으므로, 이후 세션에서는 라이선스 검증 왕복이 다시 일어나지 않습니다. 검증 결과는 앱 재시작 후에는 유지되지 않습니다.
촬영(`startDetection()` → 결과)	기다리지 않음	검출, 품질 검사, 반환되는 이미지 파일 모두 로컬에서 처리됩니다. SDK가 백그라운드로 사용량 지표를 보내지만, 촬영을 막거나 실패시키지 않습니다.
업로드 / 등록 / 검증 / 식별	필요, 앱 서버에서	Server API 참고. 촬영 파일은 기기에 보관했다가 나중에 업로드해도 됩니다.

통신이 안 되는 현장에서 운영한다면: 연결된 상태에서 라이선스를 검증해 두고(앱 실행 후 카메라를 한 번 열기), 앱 프로세스를 유지한 채 촬영하고, 연결이 복구되면 촬영 파일을 업로드하세요. 앱을 다시 실행하면 첫 initializeCamera()에 다시 네트워크가 필요합니다.

다음 단계

먼저 Petify Console에서 API 키와 SDK 배포 자격 증명을 발급받으세요(가입 즉시 사용 가능). 그다음 플랫폼별 가이드로 통합을 시작합니다:

[Petify Console] - 자격 증명 발급·사용량 관리 (시작점)
[iOS SDK] - iOS 앱 통합 가이드
[Android SDK] - Android 앱 통합 가이드
[React Native SDK] - React Native 앱 통합 가이드
[Web Integration] - 앱 통합 없이 웹 링크로 촬영 플로우 제공

Petnow SDK 개요

On this page