Integrations and developers

Your data. Your tools. Your rules.

Give another program exactly the access it needs with OAuth credentials, get a signed message on your own server the moment something happens, or paste a widget into the website you already have.

Book a demoImport and export data
Read only, Read and write or CustomSigned webhooksWidgets for any website

For the people who build things

The Developer group in Settings is for connecting Franpos to other software.

Get API

Credentials with a seatbelt

Get API uses OAuth: a client ID and secret your developer exchanges for short-lived tokens.

  • Add OAuth credential with an Application name so you know what it is for
  • Access: Read only, Read and write, or Custom with individual scopes
  • Optional IP restriction: only the IPv4 or IPv6 addresses or ranges you list can use it
  • The Client secret is shown once, so copy it straight away
  • Rotate secret keeps the current secret working until you choose Finish rotation, so nothing goes down
  • Revoke stops a credential, and the tokens it issued, within about a minute
  • Each credential acts with the permissions of the person who created it
Webhooks

Franpos tells your server first

A webhook sends a signed message to your own web address whenever something happens.

  • Events in groups: Bookings, Customers, Inventory, Orders, Payments, Memberships and Subscriptions
  • Choose the locations each webhook covers
  • A signing secret lets your server check a message really came from Franpos
  • Rotating the secret signs messages with both the old and the new secret for 24 hours, so nothing is rejected
  • Healthy, Retrying, Needs attention and Paused counts, with Pause, Resume and Delete
  • Identify records by a customer email or product SKU, so your system can match records without Franpos ids

For everyone else: connect in a few clicks

No developer needed for these.

Website widgets

Paste once. Works on any site.

Turn on a widget, copy its snippet and paste it where you want it.

  • Lead form, Loyalty signup widget and Online booking widget under Settings, Marketing
  • Allowed website domains: a widget only loads on a site on your list
  • Rotate key if a key was shared by mistake: the old snippet stops working right away
  • The online booking widget has a Test page link, and allows up to 20 websites
Email and surveys

Bring your favorite tools

Connect services you already use.

  • Mailchimp or Campaigner: choose your list and keep your customer data flowing with auto sync
  • Listen360 customer surveys
  • Delivery and ordering apps are handled on the third-party orders page
03 · Safe by default

Hand out access like a locksmith

1

Add OAuth credential

Name it after the application that will use it.

2

Choose access

Read only unless the integration must change things.

3

Limit the IP

Add the addresses the integration will call from.

4

Copy the secret

It is shown once. Share it only with the developer who needs it.

04 · Related

More ways to connect

Third-party orders

Bring delivery and ordering apps into one flow.

eCommerce

Your online store, in sync with the register.

Import and export

Move data in and out with a spreadsheet.

Questions about integrations and the API

What if a client secret is lost?
It cannot be shown again. Open Get API, choose Rotate secret on the credential, and a new secret is created and shown once. The current secret keeps working until you choose Finish rotation.
What is the difference between Read only, Read and write and Custom?
Read only can read customers, orders, products, reports and more but cannot change anything. Read and write can also create, update and delete. Custom lets you pick individual scopes, where read scopes never change anything and write scopes can.
What can a webhook send?
Events in the groups Bookings, Customers, Inventory, Orders, Payments, Memberships and Subscriptions.
Who can see the Developer settings?
The Get API and Webhooks rows each need their own permission, so ask the account owner or a manager. They are meant for a computer and are hidden on a phone.
Can I limit a credential to my office?
Yes. Add an IP restriction with the addresses or ranges that may use it. With nothing listed, any IP address may use it.
What does it cost?
Every business is different, so we quote per location. Book a demo and we will walk you through it.

Keep exploring

Import and exportBring in products, customers and staff; take your data out any time.Back office managementInventory, purchasing, staff and QuickBooks in one back office.Reports and analyticsA dashboard and reports that match, for one store or fifty.Multi-location managementRun every location from one login with chain-wide control.
See every Franpos feature →

Connect Franpos to everything else you run.

Book a demo and bring your developer along.

Book a demoThird-party orders

Trusted by thousands of businesses, including

Woof Gang BakeryTraegerRunzaMenchie'sEarthWise PetMud BayPet PlanetDog KrazyPro Image SportsPet WantsBest West Pet FoodsBrothers Country SupplySam's Cats & DogsMagoo's Pet OutletWoof MeowDogPerfectPACGatewayShubhSumUpWoof Gang BakeryTraegerRunzaMenchie'sEarthWise PetMud BayPet PlanetDog KrazyPro Image SportsPet WantsBest West Pet FoodsBrothers Country SupplySam's Cats & DogsMagoo's Pet OutletWoof MeowDogPerfectPACGatewayShubhSumUp