Hoppa till huvudinnehÄll

Skapa och hantera API-klienter

SÄ skapar och hanterar du API-klienter i Infobric Machines och sparar eller regenererar autentiseringsuppgifter för Integration API.

Skrivet av Oscar Karlsson

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

  1. Logga in i Infobric Machines.

  2. Öppna Administratör.

  3. VĂ€lj Klienthantering.

  4. VĂ€lj Skapa klient.

  5. Skriv ett tydligt namn under Klientnamn.

  6. VĂ€lj Skapa klient.

  7. Kopiera och spara uppgifterna Client ID och Client secret pÄ en sÀker plats.

  8. 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:

  1. Öppna klienten i listan.

  2. Ändra Klientnamn.

  3. VĂ€lj Editera klient.

Klientens ID Àr lÄst och kan inte Àndras.

Följ antalet API-anrop

Överst pĂ„ sidan Klienthantering visas Totalt antal frĂ„gor per mĂ„nad enligt avtal.

Uppgiften visas som tvÄ tal, exempelvis 0 / 100:

  • det första talet visar hur mĂ„nga API-anrop som har gjorts under den aktuella mĂ„naden

  • det andra talet visar hur mĂ„nga API-anrop per mĂ„nad som ingĂ„r enligt företagets avtal

Skillnaden mellan talen visar hur mÄnga anrop som ÄterstÄr inom den avtalade nivÄn. Antalet inkluderade API-anrop varierar beroende pÄ företagets avtal.

Integration API kan anvÀndas oavsett vilket produktpaket företaget har.

Generera en ny klienthemlighet

Generera en ny hemlighet om den tidigare hemligheten har förlorats, kan ha blivit exponerad eller behöver ersÀttas.

  1. Leta upp klienten under Klienthantering.

  2. VĂ€lj Generera ny hemlighet.

  3. LÀs varningen i dialogrutan BekrÀfta hemlighets-regenerering.

  4. VĂ€lj Ja, regenerera.

  5. Kopiera den nya klienthemligheten och spara den pÄ en sÀker plats innan dialogrutan stÀngs.

  6. 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.

  1. Öppna klienten under Klienthantering.

  2. VĂ€lj Ta bort klient.

  3. 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.

Relaterade artiklar
Fick du svar pÄ din frÄga?