GĂ„ til hovedinnhold

Opprett og administrer API-klienter

Slik oppretter og administrerer du API-klienter i Infobric Machines, og lagrer eller genererer ny pÄloggingsinformasjon for Integration API.

Skrevet av Oscar Karlsson

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

  1. Logg inn i Infobric Machines.

  2. Åpne Administrasjon.

  3. Velg Klientadministrasjon.

  4. Velg Opprett klient.

  5. Skriv inn et tydelig navn under Klientnavn.

  6. Velg Opprett klient.

  7. Kopier Klient-ID og Klienthemmelighet, og oppbevar dem pÄ et sikkert sted.

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

  1. Åpne klienten i listen.

  2. Endre Klientnavn.

  3. Velg Rediger klient.

Klient-ID-en er lÄst og kan ikke endres.

FĂžlg antallet API-forespĂžrsler

Øverst pÄ siden Klientadministrasjon vises Totalt antall forespÞrsler per mÄned i henhold til avtalen.

Opplysningen vises som to tall, for eksempel 0 / 100:

  • det fĂžrste tallet viser hvor mange API-forespĂžrsler som er gjort i den aktuelle mĂ„neden

  • det andre tallet viser hvor mange API-forespĂžrsler per mĂ„ned som er inkludert i bedriftens avtale

Forskjellen mellom tallene viser hvor mange forespÞrsler som gjenstÄr innenfor det avtalte nivÄet. Antallet inkluderte API-forespÞrsler varierer avhengig av bedriftens avtale.

Integration API kan brukes uavhengig av hvilken produktpakke bedriften har.

Generer en ny klienthemmelighet

Generer en ny hemmelighet hvis den forrige hemmeligheten har gÄtt tapt, kan ha blitt eksponert eller mÄ erstattes.

  1. Finn klienten under Klientadministrasjon.

  2. Velg Generer ny hemmelighet.

  3. Les advarselen i dialogboksen Bekreft generering av ny hemmelighet.

  4. Velg Ja, generer pÄ nytt.

  5. Kopier den nye klienthemmeligheten og oppbevar den pÄ et sikkert sted fÞr dialogboksen lukkes.

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

  1. Åpne klienten under Klientadministrasjon.

  2. Velg Slett klient.

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

Relaterte artikler
Svarte dette pÄ spÞrsmÄlet?