시작하기
콘솔 준비부터 첫 촬영 링크 발급, 결과 확인까지 Web Integration을 시작하는 방법을 안내합니다.
사전 준비
콘솔 가입
console.petify.petnow.io에서 가입합니다. 별도 승인 절차 없이 가입 즉시 사용할 수 있습니다.
결제수단 등록
My Page → Payment Info에서 결제수단을 등록합니다. 링크 생성과 API Key 발급의 선행 조건입니다.
첫 API Key 또는 첫 링크를 생성하면(둘 중 먼저 1회) 50 Integration Credits가 자동 지급됩니다. 자세한 내용은 Petify Console 문서를 참고하세요.
연동 방식 선택
- 개발 없이 빠르게 시작하려면 Link Integration으로 시작하세요.
- 결과를 서버에서 신뢰 가능하게 수신해 비즈니스 로직에 사용해야 한다면 Server Integration을 사용하세요.
두 방식의 차이는 Web Integration 소개의 비교표를 참고하세요. 한 계정에서 기능별로 두 방식을 조합해 사용할 수도 있습니다.
Link Integration으로 시작하기
링크 생성
콘솔의 Integration → Links → 링크 생성에서 이름, 기능(등록/인증/검색), 대상 동물(등록·검색), Redirect URL, 등록 상한(등록)을 입력합니다.
링크 전달
생성된 링크 URL을 사용자에게 전달합니다. 등록·인증 링크는 externalPetId 쿼리 파라미터가 필수입니다:
https://capture.petify.petnow.io/l/hl_2Xy7Qa9Kd3Lm4Np5Rs6Tu?externalPetId=YOUR-PET-ID-123촬영 확인
스마트폰 브라우저에서 링크를 열어 촬영 플로우를 직접 확인합니다. 촬영은 모바일 전용이며, 데스크톱에서는 진행되지 않습니다.
결과 확인
촬영이 끝나면 Redirect URL로 복귀하며 petify_status가 전달됩니다. 완료된 결과는 콘솔에서 확인하고, 인증·검색은 petify_code로 표시용 결과를 조회할 수 있습니다.
자세한 필드 설명과 링크 관리 규칙은 Link Integration을 참고하세요.
Server Integration으로 시작하기
API Key 발급
콘솔의 Integration → API & SDK에서 API Key를 발급합니다. 값은 생성 직후에만 확인할 수 있으니 안전하게 보관하세요.
허용 Redirect URL 등록
Integration → Links → 허용 Redirect URL에서 사용할 URL을 미리 등록합니다. 서버 발급에는 자동 등록이 없습니다.
세션 발급
서버에서 촬영 세션을 발급하고, 응답의 url을 사용자에게 전달합니다 (id는 반드시 저장):
curl -X POST "https://api.petify.petnow.io/v2/hosted-sessions" \
-H "x-petnow-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"action": "REGISTER",
"species": "DOG",
"redirectUrl": "https://your-service.example.com/petify/return",
"externalPetId": "YOUR-PET-ID-123"
}'결과 수신
완료 리다이렉트의 petify_code를 GET /v2/hosted-results/{code}로 소비해 결과를 받습니다. 리다이렉트가 유실되면 GET /v2/hosted-sessions/{id}로 조회합니다.
엔드포인트별 상세 스펙과 에러 코드는 Server Integration을 참고하세요.
로컬 개발 팁
Redirect URL은 HTTPS가 원칙이지만, 로컬 개발을 위해 loopback 호스트(localhost, 127.0.0.1, ::1)는 HTTP를 허용합니다. 예를 들어 http://localhost:3000/petify/return을 허용 목록에 등록하면 로컬에서 전체 플로우를 확인할 수 있습니다.
다음 단계
- Link Integration - 링크 발급·관리와 결과 확인
- Server Integration - 세션 API 상세 스펙
- Redirect URL과 결과 전달 - 허용 목록 규칙과 리다이렉트 파라미터