Install and connect the browser extension

Add the extension to Microsoft Edge and trust your {{brand}} so it can record only while you say so.

In short

The {{brand}} browser extension sees what only a real tab can: a website's API calls and your clicks. It records only while you have started it - Browser Sync for API Tester, the recorder for UI Tester. For now it runs only in Microsoft Edge. Chrome support is coming.

Before you start

• Who: anyone signed in with API Tester or UI Tester on. Recording needs Edit on the project or site.
• Plan: Browser sync is part of every plan; the number of sessions depends on it (see /help/settings/browser-sync-recording).
• First: Microsoft Edge. Install it only from the install panel.

Install it

1. Open the install panel where you need it. In an API Tester project, use the arrow beside "New request" › "Record a website…" › "Install extension". In UI Tester, open a track and press "Record".
2. The panel opens the extension's page in Microsoft Edge Add-ons (until it is published there, the panel says so). Install it in Edge and approve the browser's permissions.
3. A welcome page opens. Go back to your {{brand}} tab and refresh it. The panel says "Extension ready".

Only from the panel {{brand}} links to its extension only from the install panel. Do not install look-alikes found by searching a store for the name.

Connect it

1. With your {{brand}} tab open and signed in, click the browser's Extensions icon and choose the {{brand}} Browser Extension.
2. A card asks "Connect to …?" with the address of your {{brand}} tab, such as "Connect to https://core.example.com?". Accept only if that address is your own {{brand}}: everything you record is uploaded there.
3. Press "Trust this {{brand}}", or "Not now".
4. If it says "Open … and sign in" with your {{brand}} address, sign in there in this browser and open the extension again. Its top line then reads "Connected to", the address and the workspace.

Good to know

• It trusts one {{brand}} at a time until you press "Disconnect", which works only while nothing is recording.
• It reads only the sites you allow. The first time you trust a {{brand}} other than the cloud one, record a site, or send to a local address, the browser asks you; the extension's "Sites you allowed" list lets you take any of them back.
• Pictures of UI steps are a separate choice: the browser takes pictures of a tab only for an extension allowed on every site. Without it, steps are recorded without pictures.
• Its sign-in lasts an hour and is renewed while a {{brand}} tab is open. Signing out of {{brand}} unlinks it and discards a recording still running.
• It can list the API Tester projects you may record into, and start, feed, pause and stop recordings - nothing else.
• Alt+Shift+K opens the extension when the browser kept that shortcut; the welcome page shows the one that is set.

If something goes wrong

Related

• /help/settings/extension-privacy
• /help/settings/browser-sync-recording
• /help/settings/record-a-ui-track
• /help/api-testing/send-to-localhost