Skip to main content

API keys

With an API key, your own software can start and read payments on a profile through the SitePack API, for example your booking system, your club administration or a ticket sale. You do not need to build an app for that. Give the key to your developer; the technical details are on sitepack.dev.

A key belongs to the profile you have open and only gives access to payments, nothing else of your account.

Make a key​

  1. Open the profile you want to take payments on (see Profiles).
  2. Go to API keys in the payments menu.
  3. Under New API key, fill in:
    • Name: what the key is for, for example Booking system.
    • Mode: Live for real payments, Test to try things out (see below).
    • Access: Start and read payments, or Read payments only for software that only needs to look, such as an accounting export.
    • Valid for: 1 year or 90 days.
    • Webhook address (optional): where we send a message when a payment is paid, failed, cancelled or refunded. It has to be a public https address. You can add or change it later.
  4. Click Create key.

The key is shown once. Click Copy and store it somewhere safe, such as your developer's password manager. With a webhook address you also get a webhook secret, shown only once as well: your software uses it to check that a message really comes from SitePack.

You can have up to ten keys per profile.

Test keys​

A test key always pays in the test environment of our payment partner, even when your profile is live. No real money moves, so a developer can try everything while your webshop keeps taking real payments.

  • A test key only sees payments made with test keys. A live key never sees them.
  • Payments made with a test key carry a Test label on the Dashboard and are left out of your figures, the chart and your payouts.
  • You can tell the keys apart: a test key starts with sp_test_, a live key with sp_live_.

Manage your keys​

The list shows each key's name, access, when it was made and when it expires. A test key has a Test label. Below the name you see the webhook address; click Change to edit or clear it.

Click Revoke to stop a key straight away. Software that uses it can no longer start or read payments. A key also stops working when it expires, or when the person who made it no longer has access to the profile. Make a new key before the old one expires.

Frequently asked questions​

I lost my API key. Can I see it again?​

No, a key is only shown when you make it. Revoke the old key and make a new one.

Is an API key the same as an app?​

No. An API key is for your own software on your own profile. An app from the SitePack marketplace connects through its own installation, and you do not need a key for it.