När ska jag använda den här guiden?
Använd guiden när ett externt system ska ansluta till Infobric Machines via Integration API och behöver ett klient-ID och en klienthemlighet.
Guiden visar hur du:
skapar en API-klient
sparar klientens autentiseringsuppgifter
ändrar klientens namn
genererar en ny klienthemlighet
tar bort en API-klient
Förutsättningar
Du behöver:
ha rollen Ägare eller Administratör
ha tillgång till Infobric Machines på webben
veta vilket externt system som ska använda API-klienten
Rollen Användare har inte tillgång till Klienthantering.
Skapa en API-klient
Logga in i Infobric Machines.
Öppna Administratör.
Välj Klienthantering.
Välj Skapa klient.
Skriv ett tydligt namn under Klientnamn.
Välj Skapa klient.
Kopiera och spara uppgifterna Client ID och Client secret på en säker plats.
När uppgifterna är sparade väljer du Jag sparade klienthemligheten, stäng den här dialogrutan.
⚠️ Spara klienthemligheten innan du stänger dialogrutan. Den visas bara en gång. Om den förloras behöver du generera en ny hemlighet.
Lämna klient-ID och klienthemlighet till den person eller det system som ansvarar för API-integrationen via en säker överföringsmetod.
Se och redigera API-klienter
Under Klienthantering visas de befintliga klienterna. Där kan du bland annat se:
Klient ID
Antal frågor
Namn
Lösenordet har ändrats
tillgängliga Handlingar
Så ändrar du klientens namn:
Öppna klienten i listan.
Ändra Klientnamn.
Välj Editera klient.
Klientens ID är låst och kan inte ändras.
Generera en ny klienthemlighet
Generera en ny hemlighet om den tidigare hemligheten har förlorats, kan ha blivit exponerad eller behöver ersättas.
Leta upp klienten under Klienthantering.
Välj Generera ny hemlighet.
Läs varningen i dialogrutan Bekräfta hemlighets-regenerering.
Välj Ja, regenerera.
Kopiera den nya klienthemligheten och spara den på en säker plats innan dialogrutan stängs.
Uppdatera det externa systemet med den nya hemligheten.
När en ny hemlighet genereras kan befintliga API-integrationer sluta fungera tills deras autentiseringsuppgifter har uppdaterats.
Ta bort en API-klient
Ta endast bort en klient när det externa systemet inte längre ska ha åtkomst till Machines.
Öppna klienten under Klienthantering.
Välj Ta bort klient.
Läs varningen och bekräfta borttagningen.
⚠️ Borttagningen kan inte ångras. När klienten har tagits bort kan externa system inte längre använda den för att hämta information från Machines.
Öppna API-dokumentationen
Välj API Dokumentation på sidan Klienthantering för att öppna dokumentationen för Integration API v1.
Dokumentationen innehåller information för den som utvecklar integrationen, bland annat om autentisering och API-områden för maskiner, platser och användning.
Om det inte fungerar
Kontrollera först att:
du har rollen Ägare eller Administratör
klientnamnet är ifyllt när klienten skapas
klient-ID och klienthemlighet har kopierats korrekt
det externa systemet använder den senast genererade klienthemligheten
klienten inte har tagits bort
Om klienthemligheten har förlorats kan den inte visas igen. Generera en ny hemlighet och uppdatera sedan det externa systemet.
Om en integration slutar fungera efter att en hemlighet har regenererats kontrollerar du att det externa systemet har uppdaterats med den nya hemligheten.
Tips!
Använd ett klientnamn som visar vilket system eller vilken integration klienten tillhör.
Skapa separata klienter för olika externa system så att åtkomsten kan hanteras var för sig.
Förvara aldrig klienthemligheter i skärmbilder, vanliga e-postmeddelanden eller publika dokument.
Ta bort en klient när integrationen inte längre ska användas.