API piekļuve

WallaWhats nodrošina tās pašas operācijas, ko izmanto vadības panelis, ar JSON HTTP API starpniecību. Izmantojiet to, lai skriptētu abonementu pārvaldību, ievilktu paziņojumu vēsturi savās sistēmās vai integrētu brīdinājumus ar iekšējiem rīkiem. Katrs maksas līmenis ietver API piekļuvi — par plāna atslēgu ierobežojumiem skatīt Pārvaldīt plānu.

1. solis — Atveriet API atslēgas

Sānjoslā noklikšķiniet uz API atslēgas (sadaļā Piekļuves atslēgas).

2. solis — Izveidojiet atslēgu

1. Noklikšķiniet uz Izveidot atslēgu.
2. Piešķiriet atslēgai nosaukumu (piem., production-server, local-dev). Nosaukums ir tikai etiķete — tas neietekmē atļaujas.
3. Noklikšķiniet uz Izveidot.

Pilnā atslēgas vērtība tiek parādīta vienu reizi — nekavējoties nokopējiet to savā noslēpumu pārvaldniekā. WallaWhats glabā tikai hash plus īsu prefiksu (bws_xxxxxxxx…), tāpēc to vēlāk nevar atjaunot.

Izturieties pret atslēgām kā pret parolēm

Ikviens ar atslēgu var rīkoties jūsu kontā. Glabājiet atslēgas noslēpumu pārvaldniekā, nekad nekomitējiet tās git, un periodiski rotējiet.

3. solis — Izmantojiet atslēgu

Sūtiet atslēgu x-api-key galvenē katrā pieprasījumā:

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

Pieejamie galapunkti, pieprasījumu pamatteksti un atbildes formas ir dokumentētas API atsaucē.

4. solis — Rotācija vai atsaukšana

• Rotācija — izveidojiet jaunu atslēgu, izvietojiet to, tad izdzēsiet veco. Pēc dizaina nav "rotēt" pogas; izveidot-tad-izdzēst padara pāreju atomāru.
• Atsaukt — noklikšķiniet uz Dzēst blakus atslēgas rindai. Atslēga uzreiz pārtrauc darboties. Jebkuri lidojuma laikā veiktie pieprasījumi, kas to izmanto, atgriezīs 401 Unauthorized.

Plāna ierobežojumi

Plāns	API atslēgas
Free	1
Pro	1
Pro+	2
Business	5
Enterprise	20

Ja sasniedzat ierobežojumu, Izveidot atslēgu ir atspējots — vispirms izdzēsiet veco atslēgu vai jauniniet plānu.

Kas tālāk

Lai uzzinātu pieprasījuma/atbildes shēmas un pilnu galapunktu sarakstu, skatiet API atsauci →.