API fundamentals
Referință pentru fundamentele publice ale platformeiAPI, care acoperă căile endpoint, autentificarea tokenului OAuth, scopul organizației, paginarea și erorile.
Consola web utilizeazăGraphQL,MCPexpune instrumente construite special, prb furnizează comenzi terminale,n8npachete operațiuni comune pentru fluxuri de lucru vizuale, iar Agentul dispozitivAPIacceptă rapoarte de înscriere și postură de la agenții de punctul final.
Endpoints
Secțiune intitulată „Endpoints”Pentru originea platformei, cum ar fi https://probo.example.com, ruteleAPIsunt montate mai jos /api:
- Console GraphQL:
/api/console/v1/graphql - MCP:
/api/mcp/v1 - Cookie banner:
/api/cookie-banner/v1 - Device agent:
/api/agent/v1
Unele servicii, inclusiv descoperirea OAuth, folosesc rutele ___ZBT_I18N_RUNTIME_BLOCK_174__ pe aceeași sursă.
Authentication
Secțiune intitulată „Authentication”Creați un token de acces scalabil din meniul contului dvs. OAuth tokens pentru clienții care utilizează autentificarea purtătorului static. Selectați numai domeniile de resurse necesare, stocați tokenul într-un manager secret și rotiți-l după divulgarea suspectă.
Clienții interactivi pot utiliza fluxuri de autorizare OAuth acceptate în schimb. sesiuni SSO și jetoane SCIM servesc scopuri diferite și nu ar trebui să fie înlocuite cu un jetoan de acces OAuth.
Organization scope and identifiers
Secțiune intitulată „Organization scope and identifiers”Furnizați identificatorul organizației necesar de operațiune și nu presupuneți că un utilizator autentificat poate accesa fiecare organizație. platforma utilizează ID-uri unice la nivel global care codifică un tip de entitate; clienții trebuie totuși să trateze ID-urile ca șiruri opace.
Pagination
Secțiune intitulată „Pagination”Operațiunile de listă utilizează în mod obișnuit paginarea cursorilor. Solicitați o pagină limitată, procesați marginile acesteia și continuați cu cursorul final returnat în timp ce o altă pagină este disponibilă.
API-urile publice disting condițiile neautentificate, interzise, nedetectate, nevalide și conflictuale. Eșecurile neașteptate returnează o eroare internă generică; detaliile de implementare nu sunt expuse în mod intenționat.