Getting started
Connect your Yoco account
Make a Yoco API key so your sales and menu come through by themselves.
HeyGrug reads your sales and menu from Yoco with an API key. You make the key yourself in Yoco's Developer Console. It only needs permission to read, so it can't take payments or move money.
When you link Yoco, HeyGrug also copies about a year of past sales once, so your margins and profit have history straight away. It keeps only what sold, how many, the totals and the day: no card or customer details.
Before you start
- It takes about two minutes and is easiest on a computer.
- You need the Yoco login of the business owner (the email and password for the Yoco app or Business Portal). If someone else runs your Yoco account, send them this page.
- In HeyGrug, only the store owner can connect Yoco.
Make the key in Yoco
- Open the Yoco Developer Console and sign in with your Yoco login.
- Make a new API key. Name it "HeyGrug" so you'll recognise it later.
- Tick these two permissions and nothing else:
business/orders:read(your sales) andbusiness/catalogue:read(your menu and prices). - Copy the key. Yoco shows it only once, so keep that tab open until it's pasted into HeyGrug.
Use the Developer Console, not the keys under Payment Gateway in the Business Portal. Those start with
sk_live_ or pk_live_, are for taking payments online, and can't read your sales.Paste it into HeyGrug
- Paste the key on the first setup step, or later under Settings › Yoco, and press Connect Yoco.
- We check the key with Yoco first. That takes a few seconds, and if something's wrong we say exactly what.
- Once it says Connected, your menu comes in within a minute and each item gets a recipe and cost. Your past sales follow in the background, and a bar at the top of setup shows how far back they've come.
If it doesn't work
- "It looks like a Payment Gateway key": you copied the online payments key. Make an API key in the Developer Console instead.
- "Yoco didn't accept this key": part of the key was cut off when copying, or the key was deleted. Make a new one and paste the whole thing.
- "The key works, but it's missing the permission…": one of the two boxes wasn't ticked. Make a new key with both ticked.
- "Yoco had a problem checking the key" or "Couldn't reach Yoco": Yoco is busy or down. Your key is probably fine; try again in a minute.
- You can't sign in to the Developer Console: use the owner's Yoco login. If it still won't let you in, Yoco support can help with access.
- Only the owner can change the Yoco connection: you're signed in to HeyGrug as a manager. Ask the store owner to connect it.
Your key is encrypted before it's stored. If you ever think it leaked, delete it in Yoco, make a new one and use Replace key in HeyGrug.