Neidio i'r cynnwys
Scout Suite

Canllaw sut i wneud

Defnyddio'r API

Mae manylion mynediad yn byw ar eich cyfrif, nid ar dudalen gosodiadau grŵp. Mae'r cyfeirnod cyhoeddus ar api.scoutsuite.app; dyma sut i fathu rhywbeth a all wir ei alw.

  1. Agorwch y ganolfan ddatblygwyr

    Ar ôl mewngofnodi, ewch i Datblygwr (o'ch proffil). Tri cherdyn: Allweddi API (tocynnau Bearer ar gyfer mynediad gweinydd-i-weinydd), Tocynnau MCP (offer AI fel Cursor), ac Apiau OAuth (apiau sy'n mewngofnodi defnyddwyr gyda Scout Suite). Mae Dogfennau API yn agor y cyfeirnod llawn.

  2. Bathu allwedd API ar gyfer sgript neu weinydd

    Allwedd API newydd: enw, a all weld pob grŵp y gallwch chi gael mynediad iddo neu un yn unig, faint o ddiwrnodau tan iddo ddod i ben (365 yw'r rhagosodiad), a chwmpasau ar gyfer y meysydd y caiff eu cyffwrdd. Mae Creu allwedd API yn dangos y tocyn unwaith — copïwch ef bryd hynny. Mae galwadau'n ei ddefnyddio fel tocyn Bearer, ac mae'r allwedd yn gweithredu fel chi.

  3. Neu docyn MCP ar gyfer Cursor (a rhai tebyg)

    Ar Tocynnau MCP, rhowch enw iddo (mae'r deiliad lle yn dweud "e.e. Cursor") a Creu tocyn. Yr un syniad: tocyn Bearer, yr un caniatâd sydd gennych eisoes yn yr ap. Defnyddiwch ef o osodiad MCP yr offeryn AI yn erbyn cysylltiad MCP Scout Suite — mae'r copi o fewn yr ap yn cyfeirio at y nodiadau gosod.

  4. Apiau OAuth, os ydych yn adeiladu mewngofnod

    Mae Apiau OAuth yn cofrestru cleient: enw, URL yr ap, URIau ailgyfeirio, p'un a yw'n gleient cyhoeddus (dim cyfrinair), a pha gwmpasau Scout Suite y caiff eu gofyn amdanynt. Mae PKCE yn ofynnol. Mae hynny ar gyfer cynnyrch sy'n anfon pobl trwy "Mewngofnodi gyda Scout Suite", nid ar gyfer sgript unwaith-yn-unig — defnyddiwch allwedd API ar gyfer hynny.

    Mae dogfennau rhyngweithiol a'r contract darllenadwy-gan-beiriant i'w cael yn api.scoutsuite.app/docs. Mae SSO Grŵp ar gyfer arweinwyr a rhieni ar dudalen wahanol — Gosod SSO.

    Terfynau cyfradd: 600 o geisiadau y funud fesul allwedd API, defnyddiwr wedi mewngofnodi, neu gyfeiriad IP; 20/munud wrth anfon e-bost, SMS neu WhatsApp; 10/munud ar gyfer adborth. Dros y terfyn, cewch HTTP 429 gyda Retry-After. Mae'r terfynau fesul lleoliad Cloudflare.

Sefydlu

Mwy yn y pwnc hwn

Ardaloedd, WordPress, OSM, SSO, yr API, y modd preifatrwydd, a'r cynorthwyydd.

Pori'r holl ganllawiau