Utviklerdokumentasjon
Autentisering, tillatelser og trygg legitimasjon
Logg inn med OAuth for en agent, bruk et personlig tilgangstoken på serveren din og velg tillatelsene hver innkaller trenger.
Les som MarkdownGjennomgått av SosoAPI-teamet ·
Velg påloggingsopplysninger for innkalleren
Bruk nettleser-OAuth for en agent: brukeren logger inn og velger tilgang, og CLI-et lagrer og fornyer påloggingsopplysningene. For et backend-skript eller en CI-jobb, oppgi et personlig tilgangstoken gjennom VICKY_API_KEY. Hold påloggingsopplysninger unna nettleserkode, offentlige repositorier, ledetekster, skjermbilder og delte logger.
HTTP-eksemplene bruker SOSOAPI_ACCESS_TOKEN som servermiljøvariabel for Bearer-verdien. Det er en eksempelvariabel, ikke en CLI-innstilling. Kontroller legitimasjonen oppført for hver operasjon; personlige tilgangstokener kan ikke administrere API-nøkler.
npx sosoapi auth loginnpx sosoapi auth statusnpx sosoapi auth logoutOmfang og funksjoner
Hver forespørsel kontrollerer arbeidsområdemedlemskap og rollen operasjonen krever. Delegert OAuth begrenser også tilgang til arbeidsområdene og funksjonene brukeren valgte. agent:operate dekker lesing og forberedelse, agent:publish dekker planlegging og publisering, og agent:engage dekker fellesskapsskriving. Administrasjon av API-nøkler krever en separat tillatelse.
Et personlig tilgangstoken begrenses av eierens rolle og eventuelle lagrede funksjons- eller arbeidsområdebegrensninger. Velg bare tilgangen integrasjonen trenger; utelatte valgfrie begrensninger kan gi en nøkkel bred tilgang. Profilene core og full endrer synlig verktøyliste, ikke tillatelser. Publiseringstilgang fortsetter innenfor gitt omfang uten ny nettlesergodkjenning for hvert innlegg.
Lagring og tilbakekalling av påloggingsopplysninger
CLI-et lagrer påloggingsopplysninger i operativsystemets nøkkelring når den er tilgjengelig, eller i en lokal fil som bare eieren kan lese. OAuth-tilgangstokener varer én time og fornyes av innloggingsflyten. Bruk auth status til å diagnostisere en tilkobling i stedet for å kopiere legitimasjonsfilen.
Tilbakekall en enhet eller autorisasjon i Innstillinger → Agenter og API-tilgang, eller kjør auth logout for å logge ut gjeldende lokale enhet. Dette stopper fremtidig tilgang. Det angrer ikke publiserte innlegg eller avbryter publiseringsplaner SosoAPI allerede har akseptert; kontroller og administrer dem separat.
Endepunkter for oppstart av autentisering
De fire agent-auth-endepunktene dokumenterer innloggingsprotokollen. Bruk støttet CLI eller en ekstern OAuth-klient til innlogging; disse endepunktene er ikke tilgjengelige gjennom api post. Config, request, session og revoke-current godtar forskjellige påloggingsopplysninger og felter. Følg skjemaet for hvert endepunkt og hold øktlegitimasjon unna utdata og logger.