Getting Started

How to start with Web Integration — from console setup to issuing your first capture link and reading the result.

Prerequisites

Register a payment method

Register a payment method under My Page → Payment Info. It is a prerequisite for creating links and issuing API keys.

Creating your first API Key or your first link (whichever happens first, once per account) automatically grants 50 Integration Credits. See the Petify Console docs for details.

Choose an integration method

To start quickly with no development, begin with Link Integration.
If your server needs to receive results in a trusted form and act on them, use Server Integration.

See the comparison table in the Web Integration Introduction for the differences. You can also combine both methods per function within one account.

Start with Link Integration

Create a link

In the Console, go to Integration → Links → Create link and enter the name, function (Register/Verify/Identify), target species (Register/Identify), Redirect URL, and registration cap (Register).

Deliver the link

Deliver the created link URL to your users. Register and Verify links require the externalPetId query parameter:

https://capture.petify.petnow.io/l/hl_2Xy7Qa9Kd3Lm4Np5Rs6Tu?externalPetId=YOUR-PET-ID-123

Try a capture

Open the link in a smartphone browser and walk through the capture flow yourself. Capture is mobile-only and does not proceed on desktop.

When capture finishes, the browser returns to the Redirect URL with petify_status. Completed results are available in the Console, and Verify/Identify links additionally deliver a petify_code for a display-only result read.

For the full field descriptions and link management rules, see Link Integration.

Start with Server Integration

Issue an API Key

Issue an API Key in the Console under Integration → API & SDK. The value is visible only right after creation, so store it safely.

Register allowed Redirect URLs

Pre-register the URLs you will use under Integration → Links → Allowed Redirect URLs. Server issuance has no auto-registration.

Issue a session

Issue a capture session from your server and deliver the response's url to the user (be sure to store the 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"
  }'

Link Integration - Issuing and managing links and reading results
Server Integration - The full session API specs
Redirect URLs & Result Delivery - Allow-list rules and redirect parameters