Conectarea instrumentelor dumneavoastră prin API
API-ul permite unei aplicații terțe să acceseze datele organizației dumneavoastră în mod programatic: efective, calendare, rezervări și facturare. Se activează din două clicuri și este protejat printr-o cheie, o listă de adrese autorizate și o urmărire a consumului.
Aflați dacă API-ul vă este util
API-ul se adresează unui dezvoltator, nu unui responsabil de organizație. Servește la a pune contul dumneavoastră în dialog cu un program pe care îl scrieți sau îl configurați: un site web personalizat, un instrument de contabilitate, un ecran de afișaj propriu, o punte către un alt sistem.
Pentru nevoile curente — recuperarea listei de membri, actualizarea în masă a abonamentelor, transmiterea cifrelor către consiliul de conducere — modulele de import, de export și de rapoarte răspund fără a scrie o linie de cod.
API-ul este propus în versiune beta: funcționarea sa poate încă evolua.
Activați API-ul și recuperați cheia
- Accesați Administrare›Setări›API BETA.
- Activați Activează modulul API apoi faceți clic pe Salvează.
- Se afișează Cheie API: copiați-o cu butonul Copiază și transmiteți-o exclusiv instrumentului pe care îl conectați.
Cheia se transmite în antetul HTTP X-API-Key al fiecărei cereri. Apelurile se fac obligatoriu în HTTPS; nicio cerere necriptată nu este acceptată.
Protejați cheia
Câteva reflexe merită amintite instrumentului sau prestatorului care o folosește:
- nu depuneți niciodată cheia într-un depozit de cod; stocați-o într-un fișier de configurare aflat în afara depozitului sau într-un gestionar de secrete;
- restrângeți adresele autorizate de îndată ce instrumentul apelează de pe un server fix;
- regenerați cheia la cea mai mică îndoială — publicare accidentală, scurgere de jurnale, încheierea misiunii unui prestator.
Butonul Regenerează solicită o confirmare, apoi invalidează imediat cheia veche. Toate aplicațiile care o foloseau încetează să funcționeze până când primesc noua cheie: anunțați-le înainte de a face clic.
Restrângeți accesul după adresa IP
Activați Restricție prin adresă IP: sunt acceptate doar cererile provenite de la adresele pe care le listați, în limita a 10 adrese IPv4. Introduceți fiecare adresă apoi validați cu Adaugă; adresa dumneavoastră actuală este afișată pe ecran pentru a vă ajuta.
Este protecția cea mai eficace și cel mai des neglijată: chiar divulgată, o cheie restrânsă la adresa prestatorului dumneavoastră rămâne inutilizabilă în altă parte.
Urmăriți consumul
Ecranul afișează în permanență ce consumă cheia dumneavoastră:
- Utilizare în acest minut și Utilizare astăzi, fiecare raportată la limita sa atunci când este configurată o limită;
- Statistici de utilizare: Săptămâna aceasta, Luna aceasta, Total și Ultima cerere.
Dincolo de limitele indicate, cererile suplimentare sunt refuzate temporar. Un contor care atinge permanent plafonul semnalează în general un instrument prost reglat, care cere din nou aceleași date în buclă în loc să le păstreze în memoria cache.
Data ultimei cereri este utilă în sens invers: o cheie activată dar niciodată apelată de luni de zile este o cheie de dezactivat.
Descoperiți ce permite API-ul
Documentația completă, cu parametrii și exemple de apel, este afișată în partea de jos a ecranului modulului. În linii mari:
- Utilizatori: este singura resursă modificabilă. Puteți lista, consulta, crea, modifica și șterge conturi.
- Configurare: abonamentele, profilurile, grupurile și categoriile de vârstă se consultă, dar se configurează exclusiv din aplicație.
- Rezervare: calendarele, intervalele orare disponibile, rezervările și etichetele se consultă.
- Facturare: conturile de facturare, comenzile și plățile se consultă.
