Kirjaudu sisäänAloita ilmaiseksi
SovelluksetAlustaMarkkinapaikkaDokumentaatioHinnoitteluKirjaudu sisään
Dokumentaatio

Luo agenttitunniste

Agenttitunniste on Bearer-tunniste, joka kuuluu henkilölle ja sisältää listan käyttöoikeusryhmiä. Luo yksi jokaista agenttia ja tehtävää varten.

Mikä tunniste on ​

  • Se kuuluu sen luoneelle henkilölle (omistajalle) ja toimii osajoukolla tämän ryhmistä.
  • Se näytetään kerran. obop tallentaa vain tiivisteen, joten kadonnutta tunnistetta ei voi palauttaa; luo uusi.
  • Se alkaa merkkijonolla obop_. Kohtele sitä kuin salasanaa.
  • Vain henkilö voi luoda tunnisteita. Agentti ei voi luoda toista tunnistetta.
  • Se ei vanhene, ja se lakkaa toimimasta, kun omistaja poistetaan. Yksittäisen tunnisteen mitätöintikomentoa ei ole vielä (katso Turvallisuus).

Valitse rajaukset ​

Rajaukset ovat käyttöoikeusryhmiä. Mieti, mitä agentin pitää tehdä, ja anna sille vain nuo ryhmät. Sisäänrakennettujen sovellusten yleisiä ryhmiä:

RyhmäAgentti voi
base.userlukea ja kirjoittaa Contacts-sovelluksen tietoja (henkilötiedot pysyvät maskattuina)
crm.userlukea ja kirjoittaa liidejä ja siirtää niitä myyntiputkessa
sales.userlukea ja kirjoittaa tarjouksia ja tilauksia
invoicing.userlukea ja kirjoittaa laskuja sekä peruuttaa luonnoksia
invoicing.managerehdottaa laskun kirjaamista (ihminen hyväksyy silti)
product.userlukea tuotteita ja hintoja

Asennetut paketit tuovat omat ryhmänsä, esimerkiksi helpdesk.agent. Sovellussivuilla luetellaan kunkin sovelluksen ryhmät.

REST-rajapinnan kautta ​

Kirjaudu sisään henkilönä ja pyydä sitten tunniste. Tämä vaatii käynnissä olevan instanssin; esimerkeissä käytetään paikallista instanssia portissa 8080.

bash
curl -s -X POST http://127.0.0.1:8080/api/auth/login \
  -H 'content-type: application/json' \
  -d '{"username":"alice","password":"your password"}'

Vastaus on {"token":"obop_..."}: istuntotunniste, joka on voimassa 12 tuntia. Käytä sitä Bearer-tunnisteena agenttitunnisteen luomiseen:

bash
curl -s -X POST http://127.0.0.1:8080/api/auth/agent-token \
  -H "Authorization: Bearer $SESSION_TOKEN" \
  -H 'content-type: application/json' \
  -d '{"scopes":["base.user","crm.user"],"label":"triage-bot"}'
json
{ "token": "obop_1e00c3..." }

Kenttä scopes on pakollinen, ja siinä on oltava vähintään yksi ryhmä, joka sinulla on. Kenttä label on vapaata tekstiä. Isännöidyssä instanssissa käytä sen osoitetta osoitteen 127.0.0.1:8080 sijaan ja kirjaudu sisään rekisteröitymisessä käyttämälläsi sähköpostiosoitteella käyttäjätunnuksena.

CLI:llä ​

Jos ajat obopia itse, voit luoda tunnisteen suoraan komentoriviltä. Komento käyttää tietokantaa suoraan, joten aja se paikassa, josta tietokantaan on yhteys:

bash
obop agent-token alice --scopes base.user,crm.user --label triage-bot
text
obop_1e00c32430532fdcef...
shown once; store it like a password

Lisää --db postgres://... (tai aseta OBOP_DATABASE_URL), jos instanssi ei käytä oletusta sqlite://obop.db.

Säilytä se turvallisesti ​

  • Tallenna se ympäristömuuttujaan tai salaisuuksien hallintaan, älä repositorioon.
  • Käytä mieluiten yhtä tunnistetta agenttia ja tehtävää kohti, jotta ne voi erottaa toisistaan ja yhden voi poistaa muihin koskematta.
  • Asiakasohjelman asetustiedostossa oleva tunniste on luettavissa kaikilta, jotka voivat lukea tiedoston.

Virheet ​

VastausMerkitys
400 {"error":"an agent token needs at least one scope"}scopes oli tyhjä.
400 {"error":"you do not hold invoicing.manager, so you cannot delegate it"}Pyysit ryhmää, jota sinulla ei ole.
400 {"error":"only a human user can issue agent tokens"}Käytit agenttitunnistetta pyytääksesi toista.
401Istuntotunniste puuttuu, on väärä tai vanhentunut.

Seuraavaksi: yhdistä MCP:n kautta tai käytä REST-rajapintaa.