Această pagină este destinată dezvoltatorilor. Conectarea organizației dvs. este o OAuth 2.0 și OpenID Connect Acesta este un furnizor, astfel încât orice aplicație sau instrument poate să vă conecteze oamenii cu conturile lor Kamo și, cu permisiunea lor, să lucreze cu datele lor Kamo prin intermediul API-ului și al serverului Kamo MCP.Nimic aici nu este specific unui singur furnizor sau unui singur tip de aplicație.
Înainte de a începe
- Se deschide un administrator Setări, apoi Securitate, Identitate & autentificare, Aplicațiile conectate, și conectează aplicația (consultați Conectați o aplicație). Ei primesc un ID-ul clientului, iar pentru un site web a Un client secret, afișat o singură dată.
- Aplicația dvs. citește orice altceva de la Adresă de descoperire Pe cardul aplicației, de exemplu
https://login.yourcompany.com/.well-known/openid-configuration. Organizațiile fără o adresă web proprie au una cahttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configuration. Fiecare altă adresă din această pagină începe cu același emitent.
Permisiuni (domenii de aplicare)
O aplicație solicită permisiuni cu scope. Permisiunile de conectare sunt openid (este întotdeauna necesar), profile, email, phone, kamo.org, kamo.roles și offline_access (rămâneți conectat cu un token de reîmprospătare).
Permisiunile de date de mai jos permit unei aplicații să utilizeze API-ul în numele cuiva, fiecare reprezentând Kamo permisiuni pe care persoana le are deja. O aplicație nu poate face niciodată mai mult decât persoana ar putea face în Kamo ei înșiși: atunci când este emis un token, acesta conține numai permisiunile de date ale căror Kamo permisiuni le deține persoana în acel moment, iar fiecare apel este verificat din nou în funcție de ceea ce deține în acel moment.Ștergerea nu este niciodată disponibilă pentru o aplicație.
Domeniu de aplicare | Ce permite | Kamo permisiune de care are nevoie (oricare) |
|---|---|---|
| Citirea contactelor și a detaliilor acestora | Vizualizați contactele |
| Crearea contactelor și editarea detaliilor acestora | Crearea contactelor, editarea contactelor |
| Citiți clienții potențiali pe care îi puteți vedea, cu starea și istoricul lor | Vizualizați lead-uri |
| Creați clienți potențiali, editați-i și mutați-i prin canal | Creați clienți potențiali, editați clienți potențiali, mutați etapa clienților potențiali |
| Citirea calendarului și a evenimentelor acestuia | Vezi calendarul |
| Crearea și modificarea evenimentelor din calendar | Vezi calendarul |
| Citiți cutiile poștale pe care le puteți deschide în Kamo | Accesarea e-mailului |
| Scrierea și trimiterea de e-mailuri din cutiile poștale pe care le puteți utiliza | Accesarea e-mailului |
| Citirea notelor și a listelor de verificare | Vezi note, Vezi sarcini |
| Creați și editați note și liste de verificare | Creați note, editați note |
| Citiți documentele și fișierele pe care le puteți deschide | Vizualizați documentele |
| Încărcați documente și editați-le | Creează documente, editează documente |
| Citirea articolelor din baza de cunoștințe a organizației dvs | Vezi articole KB |
| Crearea și editarea articolelor din baza de cunoștințe | Creați articole KB, editați articole KB |
| Citiți întâlnirile și detaliile acestora | Vezi ședințele |
| Programarea, modificarea și pornirea întâlnirilor | Începeți întâlnirea, gestionați întâlnirile |
Aceeași listă, întotdeauna curentă, este la https://api.<your domain>/api/security/oidc/scopes- Da write De asemenea, această permisiune permite aplicației să citească același tip de date.
O aplicație poate solicita doar permisiunile care i-au fost acordate, iar administratorul le alege atunci când conectează aplicația: cele de conectare sub Ce poate vedea, cele de date de mai jos Lucrați cu Kamo date, unu Vezi Și unul Schimbare Comutați după tipul de date, fiecare afișând Kamo Cereți-le să activeze exact domeniile pe care le solicitați; cererea pentru unul pe care aplicația nu l-a primit eșuează cu invalid_scope.
Autentificați-vă pe cineva (cod de autorizare cu PKCE)
Trimite browserul persoanei la adresa de autorizare cu o provocare PKCE:
https://login.yourcompany.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID
&redirect_uri=https%3A%2F%2Fapp.example.com%2Fcallback&scope=openid%20profile%20contacts.read%20offline_access
&state=RANDOM&code_challenge=BASE64URL_SHA256_OF_VERIFIER&code_challenge_method=S256Se conectează, văd ce cere aplicația dvs. în cuvinte simple și apasă Permite. Adresa ta de redirecționare primește code, state și iss. Schimbă codul pentru jetoane:
curl -X POST https://login.yourcompany.com/oauth/token \
-u YOUR_CLIENT_ID:YOUR_CLIENT_SECRET \
-d grant_type=authorization_code -d code=THE_CODE \
-d redirect_uri=https://app.example.com/callback -d code_verifier=THE_VERIFIERAplicații care nu pot păstra un secret (o singură pagină, mobil, desktop, linie de comandă) trimite client_id=YOUR_CLIENT_ID în loc de -u. Răspunsul are access_token (un jeton Purtător), id_token (care s-a înscris), refresh_token (numai cu offline_access) și scope (ceea ce poartă cu adevărat jetonul).
Apelează API-ul
Trimite tokenul de acces la adresa API a organizației tale:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 cu
WWW-Authenticate: Bearer error="invalid_token": simbolul a expirat, a fost revocat sau persoana nu mai are acces Reîmprospătați-l sau conectați-vă din nou. - 403 cu
error="insufficient_scope", scope="contacts.write": token-ul nu are permisiunea de care adresa are nevoie. Cere-l la conectare. - Reading (
GET) are nevoie dereadpermisiunea de a folosi acel tip de date; orice schimbare a nevoilor de datewrite.
Lăsați aplicația să se înregistreze singură
Dacă un administrator a activat Lăsați aplicațiile să se conecteze singure (vezi acel articol), o aplicație se poate înregistra fără ca cineva să o tasteze, folosind cererea standard de înregistrare (RFC 7591).Adresa este în documentul de descoperire ca registration_endpoint:
curl -X POST https://login.yourcompany.com/oauth/register -H "Content-Type: application/json" -d '{
"client_name": "My Tool", "redirect_uris": ["http://127.0.0.1:33418/callback"],
"token_endpoint_auth_method": "none", "grant_types": ["authorization_code", "refresh_token"],
"scope": "openid contacts.read leads.read offline_access" }'Răspunsul este al tău client_id (și un client_secret pentru aplicațiile care păstrează unul) și kamo_status. IN ASTEPTARE Înseamnă că un administrator trebuie să aprobe aplicația în aplicațiile conectate înainte ca cineva să se poată conecta; până atunci, conectarea afișează mesajul „Această aplicație așteaptă aprobare” 404.
Conectați un AI asistent sau client MCP
Serverul MCP Kamo este la https://api.yourcompany.com/mcp. Orice client MCP care suportă autorizarea MCP se poate conecta: la primul său apel 401 cu un WWW-Authenticate Antet care indică spre https://api.yourcompany.com/.well-known/oauth-protected-resource/mcpApoi, clientul se înregistrează (dacă este permis) sau utilizează un ID de client pe care vi l-a dat administratorul, conectează persoana ca mai sus și trimite un mesaj către serverul de autorizare Authorization: Bearer ACCESS_TOKEN Instrumentele pe care le poate folosi sunt exact cele pe care le permit permisiunile persoanei și scopurile tokenului.
Conectați-vă pe un televizor sau pe un dispozitiv
Dispozitivele fără tastatură utilizează conectarea la dispozitiv (RFC 8628). Aplicația necesită TV sau dispozitiv Tastați sau activați conectarea la dispozitiv:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Arată-i persoanei user_code (cum ar fi WDJB-MJHT) și verification_uri, apoi sondați fiecare interval secunde:
curl -X POST https://login.yourcompany.com/oauth/token -d grant_type=urn:ietf:params:oauth:grant-type:device_code \
-d device_code=THE_DEVICE_CODE -d client_id=YOUR_CLIENT_IDPăstrați sondajul în timp ce răspunsul este authorization_pending; un slow_down Așteptați cu 5 secunde mai mult de fiecare dată.Codul durează 10 minute.
Când cineva pleacă
Eliminarea accesului unei persoane în Kamo încheie token-urile acesteia: API-ul și serverul MCP nu mai răspund imediat (în decurs de un minut), iar reîmprospătarea nu reușește » Profilul meu, Aplicații cu acces.
Articole înrudite
Alte ghiduri care răspund la întrebări similare cu acesta.
Conectați o aplicație
Conectarea unei aplicații necesită șapte pași scurți. Deschide Setări, apoi Securitate, alegeți Identitate & autentificare, apoi Aplicațiile conectate, și apăsați Conectați o aplicațieAi nevoie de ajutor? Gestionarea…
Lăsați aplicațiile să se conecteze singure
Unele aplicații, cum ar fi AI asistenți care folosesc MCP și instrumente de linie de comandă, se pot conecta singure la conexiunea organizației dvs. în loc ca un administrator să le introducă. Acest lucru se numește…
Aplicațiile conectate
Aplicațiile conectate permit utilizatorilor tăi să se conecteze la alte site-uri web și aplicații, cum ar fi WordPress, Grafana, Moodle, Nextcloud sau propriul tău site web, cu contul Kamo pe care îl au deja…
Aplicații cu acces
Organizația dvs. vă poate permite să vă conectați la alte site-uri web și aplicații cu contul organizației dvs., cum ar fi un blog al companiei, tablouri de bord sau un site de instruire. Prima dată când faceți acest…
Aprovizionare automată
Asigurarea automată permite furnizorului de identitate să mențină Kamo la zi de la sine. O persoană adăugată în furnizorul dvs. apare în Kamo, o modificare a funcției sau a departamentului acesteia o urmează, iar o…
