Ga naar hoofdinhoud

API-sleutels

Met een API-sleutel kan je eigen software via de SitePack API betalingen starten en lezen op een profiel, bijvoorbeeld je boekingssysteem, je ledenadministratie of een kaartverkoop. Je hoeft daarvoor geen app te bouwen. Geef de sleutel aan je ontwikkelaar; de technische details staan op sitepack.dev.

Een sleutel hoort bij het profiel dat je open hebt en geeft alleen toegang tot betalingen, verder niets van je account.

Een sleutel maken​

  1. Open het profiel waarop je betalingen wilt ontvangen (zie Profielen).
  2. Ga naar API-sleutels in het betalingenmenu.
  3. Vul onder Nieuwe API-sleutel in:
    • Naam: waar de sleutel voor is, bijvoorbeeld Boekingssysteem.
    • Modus: Live voor echte betalingen, Test om dingen uit te proberen (zie hieronder).
    • Toegang: Betalingen starten en lezen, of Alleen betalingen lezen voor software die alleen hoeft te kijken, zoals een export naar je boekhouding.
    • Geldig: 1 jaar of 90 dagen.
    • Webhook-adres (optioneel): waar we een bericht naartoe sturen als een betaling is betaald, mislukt, geannuleerd of terugbetaald. Het moet een openbaar https-adres zijn. Je kunt het later toevoegen of wijzigen.
  4. Klik op Sleutel maken.

De sleutel zie je één keer. Klik op Kopiëren en bewaar hem op een veilige plek, zoals de wachtwoordmanager van je ontwikkelaar. Met een webhook-adres krijg je ook een webhookgeheim, dat je eveneens maar één keer ziet: je software controleert daarmee of een bericht echt van SitePack komt.

Je kunt maximaal tien sleutels per profiel hebben.

Testsleutels​

Een testsleutel betaalt altijd in de testomgeving van onze betaalpartner, ook als je profiel live is. Er gaat geen echt geld over, dus een ontwikkelaar kan alles uitproberen terwijl je webwinkel gewoon echte betalingen blijft ontvangen.

  • Een testsleutel ziet alleen betalingen die met testsleutels zijn gedaan. Een livesleutel ziet die nooit.
  • Betalingen met een testsleutel krijgen het label Test op het Dashboard en tellen niet mee in je cijfers, de grafiek en je uitbetalingen.
  • Je herkent de sleutels aan het begin: een testsleutel begint met sp_test_, een livesleutel met sp_live_.

Je sleutels beheren​

De lijst toont van elke sleutel de naam, de toegang, wanneer hij is gemaakt en wanneer hij verloopt. Een testsleutel heeft het label Test. Onder de naam zie je het webhook-adres; klik op Wijzigen om het aan te passen of leeg te maken.

Klik op Intrekken om een sleutel direct te stoppen. Software die hem gebruikt, kan dan geen betalingen meer starten of lezen. Een sleutel stopt ook als hij verloopt, of als degene die hem maakte geen toegang meer heeft tot het profiel. Maak een nieuwe sleutel voordat de oude verloopt.

Veelgestelde vragen​

Ik ben mijn API-sleutel kwijt. Kan ik hem opnieuw zien?​

Nee, een sleutel zie je alleen als je hem maakt. Trek de oude sleutel in en maak een nieuwe.

Is een API-sleutel hetzelfde als een app?​

Nee. Een API-sleutel is voor je eigen software op je eigen profiel. Een app uit de SitePack-marketplace koppelt via een eigen installatie, daarvoor heb je geen sleutel nodig.