호스티드 세션 발급
호스티드 세션을 발급하고 최종 사용자용 웹 URL을 받습니다(Server Integration). `url`을 SMS, 웹뷰, QR 코드 등으로 최종 사용자에게 전달하세요. 세션을 폴링하려면 `id`가 필요하므로 저장해 두세요. 최종 사용자가 세션을 마치면 브라우저가 `petify_status`와 함께 `redirectUrl`로 돌아오고, `completed`일 때는 일회용 `petify_code`가 함께 전달됩니다. 서버는 `GET /v2/hosted-results/{code}`로 이 코드를 결과로 교환합니다. 요금제 때문에 차단된 실패 세션에는 `petify_code=FEATURE_UNAVAILABLE`이 담깁니다.
Authorization
VendorApiKeyAuth Petify Console에서 발급한 API 키입니다. 서버 키는 모든 경로를 호출할 수 있습니다. 클라이언트(앱) 키는 캡처 세션 생성과 이미지 업로드만 할 수 있습니다.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.petify.petnow.io/v2/hosted-sessions" \ -H "Content-Type: application/json" \ -d '{ "action": "REGISTER", "species": "DOG", "redirectUrl": "https://vendor.example.com/petify/return", "externalPetId": "customer-pet-42" }'{
"success": true,
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string",
"action": "REGISTER",
"species": "DOG",
"integrationMethod": "LINK_INTEGRATION",
"bindingSource": "SERVER_ISSUED",
"externalPetId": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"mock": true
}
}{
"errors": [
{
"code": "PETNOWB2B10001",
"details": {
"externalPetId": [
"This field is required for REGISTER."
]
}
}
]
}{
"errors": [
{
"code": "PETNOWB2B10000"
}
]
}{
"errors": [
{
"code": "PETNOWB2B10005"
}
]
}{
"errors": [
{
"code": "PETNOWB2B10010"
}
]
}{
"errors": [
{
"code": "PETNOWB2B21002"
}
]
}{
"errors": [
{
"code": "PETNOWB2B21001"
}
]
}{
"errors": [
{
"code": "PETNOWB2B21007"
}
]
}Redirect URL과 결과 전달
허용 Redirect URL 관리 규칙과, 촬영 완료 후 리다이렉트에 전달되는 파라미터를 안내합니다.
호스티드 세션 조회 GET
내 호스티드 세션 하나의 현재 상태를 조회합니다. 세션이 `COMPLETED`가 되면 `result`에 `GET /v2/hosted-results/{code}`와 같은 결과가 담깁니다. 조회해도 소모되는 것이 없으므로 필요한 만큼 자주 폴링해도 됩니다. 리디렉션이나 결과 코드를 잃어버렸을 때 사용하세요. Console 링크로 시작된 세션(Link Integration)도 함께 반환합니다.