myfactory.API

Dit dialoogvenster kan worden gebruikt om een REST API-verbinding (REST = Representational State Transfer) met toegangsgegevens te maken en te configureren. Hiermee kunt u vanuit een externe toepassing met de myfactory communiceren. Dit is voornamelijk om gegevens uit myfactory te lezen en te gebruiken in de externe applicatie, b.v. een evaluatietool zoals Microsoft PowerBI. Een overeenkomstig praktisch voorbeeld op basis van PowerBI is te vinden in het overeenkomstige hoofdstuk HowTo (>> myfactory als gegevensbron: de REST API gebruiken voor de Microsoft PowerBI-evaluatie).

Basisgegevens

U kunt de werkelijke API-verbindingen maken door een gebruikersnaam en een wachtwoord op te geven op dit tabblad "Basisgegevens".

Omschrijving

Voer hier een betekenisvolle naam in voor de API-verbinding.

Selectievakje "Inactief"

Als deze optie is ingesteld, wordt de API-verbinding die met deze vlag is gemarkeerd, standaard verborgen in de overzichtslijst. Als u de instelling van de vlag "inactief" ongedaan wilt maken, moet u eerst het inactieve recordfilter activeren zodat de API-verbinding weer in de lijst verschijnt. Vervolgens kunt u de bijbehorende haak verwijderen.

Eigenaar

Als u een eigenaar instelt, krijgt u een filteroptie om gegevenstoegang per API-verbinding en gebruiker te beperken via recordmachtigingen. Door bijvoorbeeld een geschikt toegangsniveau voor de gebruiker in te stellen, kunt u voorkomen dat projectleiders elkaars inkomsten zien via de API-verbinding. Op dezelfde manier kunt u een afzonderlijke API-verbinding definiëren voor elke vertegenwoordiger, elk met een andere eigenaar, om te voorkomen dat vertegenwoordigers elkaars contactitems zien (bijvoorbeeld het aantal bezoeken per contact) via de REST API.

In principe moet elke API-verbinding daarom om privacyredenen een afzonderlijke eigenaar met individuele recordautorisaties worden toegewezen, zodat geen enkele gebruiker er meer autorisaties over ontvangt dan via de myfactory zelf.
Dit type gegevensfiltering is een andere specifieke filterfunctie die op recordniveau werkt. Met behulp van het tabblad Gegevensconfiguratie kunt u ook extra gegevenstypebeperkingen instellen voor elke API-verbinding (zie hieronder).

Inlognaam / wachtwoord

Voer hier elke gebruikersnaam en elk wachtwoord in. U moet beide authenticeren in de externe applicatie om verbinding te maken met de myfactory-gegevensbron. Het gecodeerde wachtwoord wordt automatisch uit het invoerveld verwijderd nadat de API-verbinding is opgeslagen. Het verliest echter niet zijn geldigheid voor het maken van de API-verbinding.

Omschrijving

In dit tekstvak kunt u een handige beschrijving voor de hier gemaakte API-verbinding invoeren.

URL voor toegang tot myfactory.API

Nadat u de API-verbinding met de toegangsgegevens hebt opgeslagen, wordt automatisch een OData REST-URL in deze regel gegenereerd. In een externe applicatie adresseert deze URL de REST API, die de myfactory-gegevens ophaalt en in de applicatie importeert. De REST-interface is toegankelijk via het OData-protocol (= OpenData-protocol), dat wordt gebruikt voor op HTTP gebaseerde gegevensuitwisseling tussen twee softwaresystemen.

myfactory.API Overzicht (D)

Hier vindt u een andere URL, waarop u ook kunt klikken. Na toegang tot deze koppeling wordt een nieuw venster geopend met een beschrijving van alle myfactory-gegevensrecords die via de REST API in de externe toepassing kunnen worden geïmporteerd. Als u een enkele beschrijving (of optioneel alle) uitvouwt, ziet u ook een lijst met de afzonderlijke gegevensvelden die voor elke record worden geïmporteerd. Voor de artikelstam zijn dit bijvoorbeeld de velden "artikelnummer", "artikelstatus" en "artikeltype".

Filter 

Als u geen vestiging invoert, dan worden de gegevens van alle vestigingen in totaal geleverd. Voert u bijvoorbeeld 1 in, dan worden alleen de gegevens van vestiging 1 geleverd aan de externe applicatie. De gegevens van vestiging 2 of overige kunnen dan niet worden gebruikt.

Dataconfiguratie

De instellingen op dit tabblad bepalen welke soorten gegevenstypen een gebruiker van deze API-verbinding mag zien en lezen in de externe applicatie. Dit maakt het onder andere mogelijk om via de interface artikel- en adresgegevens en gegevens over de bus of productie te verstrekken. Extra instellingen kunnen worden gemaakt in de kolommen na het selectievakje "Actief". U kunt bijvoorbeeld de tijdsperiode definiëren waarvoor de fib-gegevens moeten worden gelezen uit de fabriek. Dit tabblad is de tweede optie van "API-gegevensfiltering" en wordt beperkt door het selectievakje "Eigenaar" op het tabblad "Basis".

LET OP!: Als u ondanks verschillende gegevenstypen geen gegevens uit myfactory in uw rapportagetool kunt importeren en de HTTP-statuscode 404 (pagina niet gevonden) kunt krijgen, start u IIS opnieuw op uw server. Als u geen toegang hebt tot het IIS of de server, neem dan contact op met uw respectieve partner.

Mutaties

Als u het mutatieprotocol voor de myfactory.API-verbindingen heeft geactiveerd (zie "Administratie / Mutatieprotocol/ Configuratie"), kunt u dit tabblad gebruiken om uw wijzigingen bij te houden.

Youtube video

Webinar: REST-API (D)