PTI

API

De API-instellingen configureren voor een koppeling met een extern systeem.

In de Beheertool kun je de API-instellingen configureren om een koppeling te maken met externe systemen of toepassingen.

Door de API correct in te stellen, kunnen gegevens veilig en automatisch worden uitgewisseld.

Behandel de gebruikersnaam, het wachtwoord en de hash als vertrouwelijke inloggegevens. Deel ze niet en bewaar ze op een veilige plek.

Bij het instellen van de API vul je de volgende onderdelen in:

Gebruikersnaam

Voer de gebruikersnaam in die wordt gebruikt om toegang te krijgen tot de API.

Wachtwoord

Voer het wachtwoord in dat hoort bij de gebruikersnaam. Met de knop Nieuw wachtwoord genereren kun je direct een nieuw, veilig wachtwoord aanmaken.

Hash

De hash is een unieke sleutel die zorgt voor veilige communicatie met de API. Vul de hash exact in zoals deze is verstrekt, zodat de authenticatie correct verloopt.

IP-bereik

Stel hier het toegestane IP-bereik in. Alleen verzoeken die afkomstig zijn van deze IP-adressen worden geaccepteerd door de API. Dit verhoogt de beveiliging en voorkomt ongeautoriseerde toegang.

Omschrijving

Geef een korte beschrijving van de API-configuratie, bijvoorbeeld het doel of de toepassing van de koppeling. Dit helpt bij het beheer en onderhoud van meerdere API-instellingen.

Overige gegevens (Metadata)

In de Beheertool kun je naast de API ook Overige gegevens (Metadata) configureren. Metadata is aanvullende informatie die je kunt koppelen aan opdrachten of taken. Deze informatie kan worden gebruikt voor filtering, rapportages of in de mobiele applicatie.

Door metadata correct te configureren, zorg je ervoor dat opdrachten bij de aanlevering juist worden gevalideerd en verwerkt.

De volledige uitleg over metadata vind je onder Overige gegevens (Metadata) in deze handleiding.