Connecting with an API key.

Before you start

Open Integrations(or step 3 of setup), pick your system's tile, and keep your system open in another tab. Three rules apply to every key:

Full access. Sarah creates, moves and cancels bookings, so a read-only key fails. No expiry. A key that expires stops your bookings on the day it expires. Copy the whole key. Many systems show a key only once.

When you paste a key, Ansa checks it with the vendor before saving it. If the vendor refuses it, nothing is saved and the message says why. Only the account owner can connect, and you create the key yourself: Ansa staff never sign in to your account to do it.

Housecall Pro

The Housecall Pro API needs the MAX plan, and only an admin can create a key. In Housecall Pro, go to My Apps → App Store → API Key Management, then Generate API Key. Choose Full access: a read-only key can't create jobs or leads. Paste it into the Housecall Pro tile.

By default each booking goes to your Job Inbox for your team to confirm. Edit setup lets you switch to Book the job on the schedule instead, and pick the employee, job type and visit length.

Workiz

Workiz needs a plan that includes the Developer API (Ultimate). In Workiz, go to Settings → Integrations → Developer, open the v2 tab and click Create New API Key. Set no expiration, and on the permissions step choose full access to all API resources: Ansa needs to create jobs. Workiz shows the key only once, so copy it straight into Ansa.

Afterwards, Edit setup sets the appointment length, the job type and who jobs are assigned to.

JobNimbus

In JobNimbus, go to Settings → API, click New API Key, and give it an Access Profile with full access, including Settings. Ansa reads your task types, workflows and users, and creates contacts and tasks.

Before Sarah can book, Ansa needs a task type for appointments, a workflow and a starting status for new callers. You can also pick a task type for callback requests, the appointment length and who tasks are assigned to.

Acuity Scheduling

Acuity's API needs a Premium or Powerhouse plan. Copy your User ID and API key from the API Credentials page in your Acuity account and enter both, then click Verify and continue.

Next, choose the calendar and appointment type Ansa uses for every booking. Classes, series, types longer than 120 minutes and types with required intake questions can't be selected. Until you save this choice, the tile reads Finish setup.

Cal.com

Ansa works with Cal.com cloud, US. In Cal.com, go to Settings → Developer → API keys and create a key. Set its expiry to Never expires. The key starts with cal_live_; paste all of it.

Then pick the event type Ansa books. Event types that need you to confirm each booking, take a payment, use seats, repeat, or have required questions Ansa can't answer are listed as not selectable, with the reason. Cal.com still sends its own notices about bookings.

Replacing a key

To swap in a new key, create it in your system first. Then on Integrations, click + Connect another, pick the same system and paste the new key. Ansa checks it and it replaces the old one. Delete the old key in your system only after the new one is saved.

If your system stops accepting the saved key, the tile shows Reconnect needed and a banner offers Reconnect, which opens a box for the new key. Bookings Sarah took in the meantime are held and added automatically once the new key works. See A booking didn't reach my CRM.

Troubleshooting