This feature is switched on by request. If you cannot see it in your account, email help@happypet.care and ask for it to be turned on.

The Public API lets another system you use pull information out of Happy Pet on its own, without anybody copying it across by hand. Your accountant's software reading your invoices is the usual reason for it.

This article is for getting set up and handing the details to whoever is building that connection. You do not need to understand the technical side to do your part.

Before you start

If you go to Settings → Public API and are told the page cannot be found, your account does not have it yet. Email help@happypet.care and ask for it to be turned on.

Generate your token

The token is the password the other system uses to identify itself as your business.

  1. Go to Settings → Public API.
  2. Press Generate token.
  3. Copy the token straight away, using Copy token.

You are warned on screen, and it is worth taking seriously: copy the token now, because you will not be able to see it again. If you lose it, the only way forward is to make a new one, which stops the old one working.

Look after it like a password

Anyone holding this token can read your business information. Treat it the way you would treat your own login.

Send it to your developer the same way you would send a password, not in a group chat or an email thread that other people can see. One token covers your whole company, so there is nothing smaller you can hand over instead.

Checking on your token

The panel shows Expires on with how many days are left, and Last used, which says when something last connected with it.

Last used: never on a token you set up a while ago usually means the other system was never finished, or it is using the wrong token.

When it is close to expiring, or has expired

An expired token stops the connection until you replace it. You will see:

This token has expired. Regenerate to restore access.

Press Regenerate token and give the new one to whoever looks after the connection.

Regenerating stops the old token immediately

Before it does anything, you are asked to confirm:

The current token will stop working immediately. Any integration using it must be updated with the new token.

So do not regenerate to tidy up. Anything already using the old token stops working the moment you press it, and stays broken until somebody puts the new token in. Arrange it with whoever manages the connection first.

What the connection can do

The Public API page lists the calls available, such as getting invoice details and sales return details, with the filters each one accepts.

You do not need to read that part. Send whoever is building the connection to this page and it tells them what they need.