Når skal jeg bruke denne veiledningen?
Bruk veiledningen når et eksternt system skal kobles til Infobric Machines via Integration API og trenger en klient-ID og klienthemmelighet.
Veiledningen viser hvordan du:
oppretter en API-klient
lagrer klientens påloggingsinformasjon
endrer navnet på klienten
genererer en ny klienthemmelighet
sletter en API-klient
Forutsetninger
Du må:
ha rollen Eier eller Administrator
ha tilgang til Infobric Machines på nettet
vite hvilket eksternt system som skal bruke API-klienten
Rollen Bruker har ikke tilgang til Klientadministrasjon.
Opprett en API-klient
Logg inn i Infobric Machines.
Åpne Administrasjon.
Velg Klientadministrasjon.
Velg Opprett klient.
Skriv inn et tydelig navn under Klientnavn.
Velg Opprett klient.
Kopier Klient-ID og Klienthemmelighet, og oppbevar dem på et sikkert sted.
Når opplysningene er lagret, velger du Jeg har lagret klienthemmeligheten, lukk denne dialogboksen.
⚠️ Lagre klienthemmeligheten før du lukker dialogboksen. Den vises bare én gang. Hvis den går tapt, må du generere en ny hemmelighet.
Del klient-ID-en og klienthemmeligheten med personen eller systemet som er ansvarlig for API-integrasjonen, ved hjelp av en sikker overføringsmetode.
Se og rediger API-klienter
Eksisterende klienter vises under Klientadministrasjon. Der kan du blant annet se:
Klient-ID
Antall forespørsler
Navn
Passordet ble endret
tilgjengelige Handlinger
Slik endrer du klientnavnet:
Åpne klienten i listen.
Endre Klientnavn.
Velg Rediger klient.
Klient-ID-en er låst og kan ikke endres.
Generer en ny klienthemmelighet
Generer en ny hemmelighet hvis den forrige hemmeligheten har gått tapt, kan ha blitt eksponert eller må erstattes.
Finn klienten under Klientadministrasjon.
Velg Generer ny hemmelighet.
Les advarselen i dialogboksen Bekreft generering av ny hemmelighet.
Velg Ja, generer på nytt.
Kopier den nye klienthemmeligheten og oppbevar den på et sikkert sted før dialogboksen lukkes.
Oppdater det eksterne systemet med den nye hemmeligheten.
Når en ny hemmelighet genereres, kan eksisterende API-integrasjoner slutte å fungere frem til påloggingsinformasjonen er oppdatert.
Slett en API-klient
Slett bare en klient når det eksterne systemet ikke lenger skal ha tilgang til Machines.
Åpne klienten under Klientadministrasjon.
Velg Slett klient.
Les advarselen og bekreft slettingen.
⚠️ Slettingen kan ikke angres. Når klienten er slettet, kan eksterne systemer ikke lenger bruke den til å hente informasjon fra Machines.
Åpne API-dokumentasjonen
Velg API-dokumentasjon på siden Klientadministrasjon for å åpne dokumentasjonen for Integration API v1.
Dokumentasjonen inneholder informasjon for den som utvikler integrasjonen, blant annet om autentisering og API-områder for maskiner, steder og bruk.
Hvis det ikke fungerer
Kontroller først at:
du har rollen Eier eller Administrator
klientnavnet er fylt ut når klienten opprettes
klient-ID-en og klienthemmeligheten er kopiert riktig
det eksterne systemet bruker den sist genererte klienthemmeligheten
klienten ikke er slettet
En klienthemmelighet som har gått tapt, kan ikke vises på nytt. Generer en ny hemmelighet, og oppdater deretter det eksterne systemet.
Hvis en integrasjon slutter å fungere etter at en ny hemmelighet er generert, må du kontrollere at det eksterne systemet er oppdatert med den nye hemmeligheten.
Tips!
Bruk et klientnavn som tydelig viser hvilket system eller hvilken integrasjon klienten tilhører.
Opprett separate klienter for ulike eksterne systemer, slik at tilgangen kan administreres hver for seg.
Oppbevar aldri klienthemmeligheter i skjermbilder, vanlige e-postmeldinger eller offentlige dokumenter.
Slett en klient når integrasjonen ikke lenger skal brukes.