Ove su upute za razvojne programere koji povezuju vlastitu aplikaciju sa Simbiozom. API omogućuje rad s postojećim korisnicima, sadržajem, područjima, kalendarima, anketama i osobnim podacima za koje vlasnik ključa već ima pravo. Ne zamjenjuje administratorsko podešavanje instalacije niti prijavu ispitanika u anketu.
Kako započeti
- Administrator instalira/aktivira API i izda ključ s potrebnim scopeovima.
- U početnom poglavlju postavite adresu i pročitajte identitet
/api/v1/me. - Provjerite dostupne resurse i OpenAPI na svojoj instalaciji.
- Otvorite poglavlje resursa i slijedite primjer stvaranja, čitanja, izmjene ili izvoza.
- Provjerite i pogreške: ključ ne daje pristup tuđem privatnom sadržaju.
Poglavlja
Priručnik pokriva svih 114 registriranih REST ruta u cjelovitoj instalaciji. Survey ruta s nazivom radnje ima 10 dopuštenih operacija, pa je prikazano ukupno 123 odvojeno provjerenih operacija. Modularna instalacija prikazuje samo resurse čiji su moduli instalirani i aktivni. OPTIONS za CORS i zasebni CalDAV ne ulaze u taj zbroj.
Svaki primjer navodi metodu, putanju, ovlast, parametre, curl naredbu, stvaran odgovor i provjerene kodove pogreške. Adresa je zamijenjena primjerom vaše instalacije; ključevi i tajne nisu objavljeni. Snimke odgovora potječu iz sintetičkih podataka, zato se imena, ID-ovi i vremena razlikuju od vaših. Veliki odgovori ponekad imaju izričiti jq odabir; prikazani JSON tada je stvarni rezultat tog filtra.
Upravljanje API ključevima za administratora. API pravila, greške i potpuni PHP klijent.