‹ Overzicht
Freave Services API

› Aan de slag met de Freave API

Foutafhandeling

Authenticatie



Aan de slag met de Freave API

Gepubliceerd op 12-08-2018

De Freave API maakt het mogelijk alle diensten van Freave met uw eigen systemen te integreren. Zo kunt u bepaalde handelingen automatiseren.

Voorbeelden

U heeft een groot bedrijf en u wilt het voor uw developers mogelijk maken zelf testservers te creëren. U kunt er dan voor kiezen een eigen dashboard te maken - geïntegreerd met de Freave API - waar developers zelf servers kunnen aanmaken.

U gebruikt onze Antwoordlinkjes om snel antwoord te krijgen op korte vragen - maar bent veel tijd kwijt aan het steeds opnieuw aanmaken van dezelfde (soort) linkjes. Met onze API kunt u dit automatiseren.

Aan de slag

Om u bij de API te authenticeren gebruikt u zogenaamde “Access Keys”. Anders dan bij sessies zijn deze voor altijd geldig, en kunnen deze standaard vanaf elk IP-adres worden gebruikt. U heeft de mogelijkheid om Access Keys tot 1 IP te beperken om te voorkomen dat uw Key kan worden gebruikt als deze uitlekt. U kunt Access Keys na uitgifte ook invalideren, daarna kunnen ze niet meer worden gebruikt.

  1. Log in op ons nieuwe klantportaal
  2. Ga naar “gegevens” -> “API-toegang”
  3. Ga naar “een nieuwe access key toevoegen”
  4. Geef een referentie op voor de Access Key, bijvoorbeeld “Bedrijfsdashboard”
    • (Optioneel) Geef een IP-adres op om uw Access Key tot een enkel IP-adres te beperken.
  5. Selecteer “Access Key aanmaken”
  6. U komt nu in het overzicht van al uw Access Keys (nieuwste boven)
  7. Gebruik onze API-documentatie om uw Access Key te gaan gebruiken

De Freave API

De Freave API wordt aangeboden als REST API. Alle responses zijn volgens de JSON API specificatie (versie 1).

Basis eindpunt: https://api.freave.com/v4/
Huidige versie: 4 (v4)
Schema: HTTPS (De API is niet via HTTP te gebruiken)
Authenticatie: Middels een sessie of API token

Documentatie

We vinden dat onze API-gebruikers een speciaal plekje verdienen, daarom hebben we onze API-documentatie op een andere site geplaatst. U vindt onze API-documentatie op apidocs.freave.com.