Hoe werkt de API manager?

De API Manager is een handige tool waarmee je nieuwe API’s kunt aanschaffen, bestaande API’s kunt beheren en hun instellingen kunt aanpassen. Hieronder lees je hoe je de API Manager gebruikt, inclusief uitleg van de velden die je kunt tegenkomen.

Stappen voor het aanschaffen van een nieuwe API

1. Open de Servicedesk
   Klik in de menubalk aan de linkerzijde op Servicedesk.

2. Ga naar de Marketplace
   Selecteer Marketplace in het Servicedesk-menu.

3. Kies een API
   Blader door de beschikbare API’s en klik op de gewenste API.

4. Open de API Manager
   Er verschijnt een pop-up waarin de API Manager wordt geopend.

De API Manager openen vanuit de instellingen

1. Ga naar Instellingen
   Open het menu Instellingen.

2. Selecteer API Manager
   Klik onder het kopje API op API Manager.

3. Start met beheren
   De API Manager opent nu, klaar voor gebruik.

Toelichting bij velden in de API Manager

• Developer ID
  Voer het Developer ID in dat via het Realworks Developers Portal beschikbaar is. Dit vind je in het Dashboard van de ontwikkelaar. Je kunt ook direct contact opnemen met de ontwikkelaar via de knop Mail Developer.

• Token
  Een uniek token wordt gegenereerd en naar de ontwikkelaar gemaild zodra de API is opgeslagen.

• Weergavenaam
  Pas de naam van de API aan om meerdere koppelingen makkelijk te herkennen.

• Relatie
  Koppel de API aan een specifieke relatie. Kies een bestaande relatie uit het CRM of maak een nieuwe aan, die direct wordt gekoppeld.

• Gebruikersvoorwaarden
  Bij de eerste aanvraag van een API kun je hier aanvullende voorwaarden invoeren. Deze worden toegevoegd aan de standaardvoorwaarden van Realworks.

• Toegestane IP-adressen
  Specificeer de IP-adressen van waaruit de API kan worden aangeroepen.

Uitleg over specifieke API-velden

Agenda/Taken API

• Rechten: Maak specifieke inzagerechten beschikbaar.
• Dagen vanaf/tot: Definieer de periode (max. 730 dagen) waarbinnen data wordt opgehaald.
• Iedereen en privé: Selecteer welke taken zichtbaar moeten zijn.

Onroerend Goed API's (Wonen, Nieuwbouw, Aankoop, BOG)

• Basisgegevens: Standaard gegevens zoals adres en objectmedia.
• Objectgegevens: Alle beschikbare objectinformatie.
• Transactiegegevens: Gegevens zoals transactieprijs en transportdatum.
• Relatiegegevens: Koppelcodes van alle relevante relaties, op te halen via de Relatie API.
• Vragenlijst en Lijst van Zaken (alleen voor Wonen API): Ophalen van specifieke formulieren (versie 2019).

Facturatie API

• Geen niveaus; de API geeft facturatiegegevens van een vestiging en gekoppelde administratie.

Relatie API

• Basis: Naam, adres, telefoon, e-mail, en uitschrijflink.
• Plus: Extra kenmerken en toekomstige adresgegevens.
• Compleet: Aanvullend op eerder genoemde, inclusief geboortedatum, ID-gegevens, en nationaliteit.

Afronden en opslaan

Na het invullen van alle velden kun je kiezen voor Bewaar of Bewaar/Sluit. De gekoppelde relatie ontvangt vervolgens een e-mail met het token en de voorwaarden. Deze moeten door de ontwikkelaar worden ondertekend.

Met de API Manager kun je efficiënt werken en jouw API-integraties optimaal beheren!