lekkin

Help / Developers

Building in the sandbox

DevelopersClub admins, and anyone with the Developer role3 min read

The sandbox is where you build. It’s a copy of your club with test data, test keys and a caught-email inbox, and it doesn’t need the developer add-on.

Getting there

Choose Sandbox in the menu. It switches you over and opens the Sandbox page; a banner says you’re in the sandbox, and the menu item now reads Exit Sandbox. The Sandbox page shows the emails your calls caused, and lets you reset it.

The first time, LEKKIN builds your sandbox club: your club’s name and colours, three teams with squads, a league of fixtures with some results, and a pitch with opening hours and bookings. Everybody in it is made up.

What’s different

  • Keys are test keys. Integrations, keys and webhooks made here exist only here.
  • Nothing is sent. Emails your calls would cause, like an invitation to a player you added, are kept on the Sandbox page instead, newest first.
  • It’s yours to break. Add players, book the pitch, record results. None of it touches your real club.

Where your data is

The sandbox has its own copy of the API and its own data. Whatever your integration creates there with a test key, a player for example, is kept in the sandbox and never reaches your real club. To see it, ask the API for it, as your integration would: list the team’s squad and the player you added is in it.

Trying a call

Open API docs and press Authenticate, the button in the bottom corner. It fills in a test key for your sandbox club, good for an hour, so you can press Try it on any call; the response is shown underneath. Your club’s id is already filled in. (You can still paste a test key of your own instead.)

Starting again

On the Sandbox page, press Reset the sandbox. Your sandbox club goes back to how it began, with the same id, so your code keeps working. Your sandbox integrations and keys are kept.

When it works

Make the same integration on Live and issue a live key. Live keys need the developer platform add-on: see Going live.

Still stuck? Tell us what you were trying to do.