OAuth or Register API?

When building an integration with Piggy, this is the first question you must ask yourself. Piggy offers two major API routes, each with specific use cases – and therefore pro's and cons – in mind. It's important to think about which route fits your aims best. In some more complex cases, you might even want to use both.

Register API

The Register API is our API built specifically with registers (and similar products) in mind. As many registers are relatively simple devices which often have no back-office and don't support OAuth clients, the simpler API keys are used here. The register API keys can be created in the Business Dashboard, and can then be linked to a specific shop and device (i.e. a tablet running the Piggy Business App). If you're looking to create an integration for registers or similar physical devices (e.g. order kiosks), we recommend you use these routes as they are easier to implement.

OAuth API

The OAuth API uses – as the name suggests – OAuth clients. These are mostly used for integrations with web based applications, such as webshops. As they can be more flexible, it's marginally more complex to implement compared to the Register API. For any web based application, we suggest you use the OAuth API.

Not sure which to use?

We're happy to help. Send us an email or join our development Slack channel.