Adresa API și mediile

API-ul Sursa are propria adresă, separată de adresa la care utilizatorii deschid Sursa în browser. Toate căile încep cu /v1.

Unde rulează Sursa	Adresa API	Acest portal
Cloudul Sursa	`https://api.sursa.com`	`https://developers.sursa.com`
Propria instalare	`https://api.<your domain>`, așa cum a configurat-o administratorul	`/developers/` la adresa API
Instalarea fără o adresă API separată	adresa principală a instalării	`/developers/` la adresa principală

Adresa API servește doar API-ul: nu are pagină de autentificare, cookie-uri sau interfață web. Fiecare cerere este autentificată cu o cheie API sau cu un token de acces OAuth. Adresa poate fi servită de mai multe servere aflate în spatele unui echilibrator de sarcină; integrarea nu trebuie să știe câte sunt.

Integrările care apelează API-ul la adresa principală (de exemplu https://app.sursa.com/v1) funcționează în continuare. Vedeți Treceți la adresa API pentru puținele diferențe și o trecere pas cu pas.

URL de bază

Construiți fiecare cerere pornind de la un singur URL de bază din configurație, astfel încât același cod să ruleze în orice mediu:

export SURSA_API="https://api.sursa.com"
curl "$SURSA_API/v1/me" -H "Authorization: Bearer $SURSA_API_KEY"

Folosiți doar HTTPS și nu lăsați cheia să ajungă în jurnalele cererilor pe care le faceți.

Versiune și specificație

GET /v1/health arată dacă adresa funcționează și returnează versiunea Sursa care o servește. Răspunde fără cheie, așa că îl puteți folosi în monitorizare:

curl https://api.sursa.com/v1/health

{"ok": true, "version": "v1.4.0"}

Aceasta este versiunea lansării Sursa, nu a API-ului. Versiunea API-ului este info.version din specificația lui. Specificația OpenAPI 3.1 a API-ului este publicată la aceeași adresă, fără autentificare:

Cale	Conținut
`GET /openapi.json`	Specificația publică, cu această adresă în `servers`.
`GET /v1/openapi-public.json`	Aceeași specificație. Acceptă `ETag` și `If-None-Match`.

Folosiți-o pentru a genera un client, pentru a importa API-ul într-un instrument precum Postman sau pentru a verifica în CI că integrarea folosește doar operații din versiunea așteptată. Referința API a acestui portal este construită din același fișier.

Testare

Sursa nu are un mod de test separat: fiecare cerere cu o cheie lucrează cu datele reale ale organizației ei. Pentru a dezvolta și a testa în siguranță:

Creați o cheie separată pentru dezvoltare, cu cel mai restrâns rol și cele mai restrânse domenii de acces de care are nevoie lucrul.
Scrieți într-o colecție dedicată, de exemplu sandbox, pe care o vede doar echipa dumneavoastră, și ștergeți-o când terminați.
Dacă firma are o organizație sau o instalare Sursa separată pentru teste, îndreptați URL-ul de bază și cheia spre ea. Nimic altceva din cod nu se schimbă.
Faceți reîncercările sigure de la început: trimiteți un Idempotency-Key cu fiecare POST și PATCH.

Consola Încercați de pe pagina fiecărui endpoint din referința API trimite cereri reale cu o cheie pe care o lipiți în ea. Cheia rămâne în memoria filei browserului și este trimisă doar la adresa API.

Cerințe de rețea

HTTPS de ieșire (portul 443) de la serverele dumneavoastră către adresa API.
În regulile de firewall, permiteți numele de gazdă în locul unor adrese IP fixe, acolo unde rețeaua permite acest lucru: serverele din spatele adresei se pot schimba pe măsură ce se adaugă capacitate.
Aplicațiile din browser pot apela API-ul direct: răspunsurile permit orice origine (Access-Control-Allow-Origin: *) fără cookie-uri. Nu uitați că o cheie folosită într-un browser este vizibilă pentru utilizatorul acelui browser.