API prieiga

WallaWhats atskleidžia tas pačias operacijas, kurias naudoja prietaisų skydelis, per JSON HTTP API. Naudokite jį prenumeratos valdymui scenarijuoti, pranešimų istorijos perkėlimui į savo sistemas arba įspėjimų integravimui su vidiniais įrankiais. Kiekvienas mokamas lygis apima API prieigą — žr. Tvarkyti planą dėl raktų ribų pagal planą.

1 žingsnis — Atidarykite API raktus

Šoninėje juostoje spustelėkite API raktai (dalyje Prieigos raktai).

2 žingsnis — Sukurti raktą

1. Spustelėkite Sukurti raktą.
2. Suteikite raktui pavadinimą (pvz., production-server, local-dev). Pavadinimas tik etiketė — neturi įtakos teisėms.
3. Spustelėkite Sukurti.

Visa rakto vertė rodoma vieną kartą — nedelsdami nukopijuokite ją į savo paslapčių tvarkyklę. WallaWhats saugo tik hash ir trumpą priešdėlį (bws_xxxxxxxx…), todėl vėliau jo negalima atkurti.

Elkitės su raktais kaip su slaptažodžiais

Bet kas, turintis raktą, gali veikti jūsų paskyroje. Saugokite raktus paslapčių tvarkyklėje, niekada nekomitavykite į git, ir periodiškai rotuokite.

3 žingsnis — Naudokite raktą

Siųskite raktą x-api-key antraštėje kiekvienoje užklausoje:

curl -H "x-api-key: bws_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  https://api.wallawhats.com/subscriptions

Galimi galiniai taškai, užklausų korpusai ir atsakymo formos dokumentuoti API nuorodoje.

4 žingsnis — Rotacija arba atšaukimas

• Rotacija — sukurkite šviežią raktą, įdiekite jį, tada pašalinkite seną. Pagal dizainą nėra mygtuko "rotuoti"; sukurti-tada-pašalinti daro perėjimą atominį.
• Atšaukti — spustelėkite Pašalinti šalia rakto eilutės. Raktas iš karto nustoja veikti. Bet kokios vykstančios užklausos, naudojančios jį, grąžins 401 Unauthorized.

Plano ribos

Planas	API raktai
Free	1
Pro	1
Pro+	2
Business	5
Enterprise	20

Jei pasiekiate ribą, Sukurti raktą yra išjungtas — pirma pašalinkite seną raktą arba atnaujinkite planą.

Kas toliau

Užklausos/atsakymo schemoms ir pilnam galinių taškų sąrašui žr. API nuoroda →.