API v1

API-dokumentaatio

Kaikki minkä paneeli tekee, koodisi voi tehdä myös. JSONia sisään, JSONia ulos.

Todennus

Luo avain paneelin API-avaimet-sivulla ja lähetä se Bearer-tokenina.

Oikeudet

Lukuavaimella onnistuu jokainen GET. Kirjoitus vaatii luku- ja kirjoitusavaimen.

Rajat

600 pyyntöä tunnissa per avain. Ylitys palauttaa HTTP 429.

Pikaopas

# 1. Kuka olen ja paljonko tilaa on jäljellä? curl -H "Authorization: Bearer $AMH_KEY" \ https://business.alaniver.fi/api/v1/me # 2. Lisää domain — julkaise palautettu TXT-tietue ja vahvista curl -X POST -H "Authorization: Bearer $AMH_KEY" \ -H "Content-Type: application/json" \ -d '{"domain":"yritys.fi"}' \ https://business.alaniver.fi/api/v1/domains curl -X POST -H "Authorization: Bearer $AMH_KEY" \ https://business.alaniver.fi/api/v1/domains/yritys.fi/verify # 3. Luo postilaatikko curl -X POST -H "Authorization: Bearer $AMH_KEY" \ -H "Content-Type: application/json" \ -d '{"address":"info@yritys.fi","name":"Info","quota_mb":2048,"password":"…"}' \ https://business.alaniver.fi/api/v1/mailboxes

Tili

GET /api/v1/me Tili, tilaus ja tallennustilan käyttö. luku

Domainit

GET /api/v1/domains Listaa domainit ja niiden vahvistustilan. luku
POST /api/v1/domains Lisää domain. Palauttaa julkaistavan TXT-tietueen. kirjoitus
POST /api/v1/domains/{domain}/verify Tarkista TXT-tietue ja ota posti käyttöön. kirjoitus
GET /api/v1/domains/{domain}/dns Kaikki tarvittavat DNS-tietueet ja niiden elävä tila. luku
DELETE /api/v1/domains/{domain} Poista domain ja kaikki sen laatikot. kirjoitus

Postilaatikot

GET /api/v1/mailboxes Listaa laatikot kiintiöineen ja käyttöineen. luku
POST /api/v1/mailboxes Luo laatikko (address, quota_mb, password, name). kirjoitus
PATCH /api/v1/mailboxes/{address} Muuta quota_mb, password tai active. kirjoitus
DELETE /api/v1/mailboxes/{address} Poista laatikko pysyvästi. kirjoitus

Aliakset

GET /api/v1/aliases Listaa aliakset. luku
POST /api/v1/aliases Luo alias (address, goto). kirjoitus
DELETE /api/v1/aliases/{id} Poista alias. kirjoitus

Tuki

GET /api/v1/tickets Listaa tikettisi. luku
POST /api/v1/tickets Avaa tiketti (subject, message, priority). kirjoitus
GET /api/v1/tickets/{id} Tiketti viesteineen. luku
POST /api/v1/tickets/{id}/reply Vastaa tikettiin (message). kirjoitus

Virheet

Virheet palautuvat vastaavalla HTTP-koodilla ja tämän muotoisena:

{ "error": { "type": "invalid", "message": "Tallennustilasi ei riitä. Vapaana 2 GB…" } }
Luo avain