Ime Protokol strežnika

The protocol used by Jami to query and register a name is based on an HTTP REST API answering requests with JSON documents and regular HTTP status codes.

Javni name server je gostovan na ns.jami.net in uporablja blokčein kot svoj backend.

Če upravljate svoj lastni nameserver, boste po iskanju uporabniškega imena v obliki username@example.com poiskali ime username s nameserverjem na example.com. (Ni potrebe po dodajanju @ns.jami.net za uporabo privzetega nameservera.)

Pravila o oblikovanju imena

Uporabniška imena preverja regex, da zagotovijo nekatere pravila glede njihovega formata:

  • Dolžina mora biti med 3 in 32 znakoma

  • Those characters must be alphanumerical with dashes - being also accepted.

Vprašanje ime

To je glavna storitev, ki jo zagotavlja name server.

Zahtevki

Zahtevka za ime foobar je zahtevek GET z /name/foobar kot URI.

Odziv (uspešnost)

Če je ime najdeno, mora biti odgovor z statusno kodo 200 OK poslani klicentu z poljem Content-type, ki je nastavljen kot application/json.

Organ je JSON dokument z 2 atributoma: name in addr. name je enak zahtevano in addr je šestdesetna predstavitev ID Jami z prefixom 0x.

V našem primeru bi bil odgovor na JSON:

{
    "name":"foobar",
    "addr":"0x29347542eb07159f316577e1ae16243d152f6b7b"
}

Odgovor (ne najdemo)

Če ime ni mogoče najti, mora biti odgovor z statusno kodo 404 Not Found poslani stranki z poljem Content-type, ki je nastavljen kot application/json.

Telo je JSON dokument z 1 vrstico atributom: error. Ta atribut je napolnjen z sporočilom o napaki, ki pojasnjuje napako (in ga je mogoče prikazati v stranki v prihodnosti).

V zvezi z referenčno izvedbo je vrnjen dokument:

{
    "error":"name not registred"
}

Vprašanje za naslov

Ta storitev je obrnitev. Poizvedite naslov in uporabniško ime se vrne, če je registrirano na ime strežnika.

Zahtevki

Zahtevka za ID jami:29347542eb07159f316577e1ae16243d152f6b7b je zahtevek GET z /addr/29347542eb07159f316577e1ae16243d152f6b7b kot URI.

Odziv (uspešnost)

Če naslov ustreza uporabniškemu imenu, se odziv z statusno kodo 200 OK pošlje klicentu z poljem Content-type, ki je nastavljen kot application/json.

Telo je JSON dokument z 1 znakom: name. Vrednost tega polja je ime, registrirano na ta naslov

V našem primeru bi bil odgovor na JSON:

{
    "name":"foobar"
}

Odgovor (ne najdemo)

Če naslov ni na voljo, se odgovor z statusno kodo 404 Not Našel pošlje klicentu z poljem Content-type, ki je nastavljen kot application/json.

Telo je JSON dokument z 1 vrstico atributom: error. Ta atribut je napolnjen z sporočilom o napaki, ki pojasnjuje napako (in ga je mogoče prikazati v stranki v prihodnosti).

V zvezi z referenčno izvedbo je vrnjen dokument:

{
    "error":"address not registred"
}

Registriranje imena

Ta del protokola se uporablja za registracijo novega imena/naslova par.

Zahtevki

Zahtevka za registracijo imena foobar je zahtevek POST z /name/foobar kot URI. Atribut glave Content-type je treba nastaviti na application/json.

V tem primeru se lahko vnesete v skupno stranko, ki je vnesena v skupno stranko.

Primer za foobar bi lahko bil:

{
    "addr":"0x29347542eb07159f316577e1ae16243d152f6b7b",
    "owner":"foobar"
}

Odziv (uspešnost)

Če je par imena/naslova uspešno registriran, mora biti odgovor z statusno kodo 200 OK poslani stranki z poljem Content-type, ki je nastavljen kot application/json.

V telesu je dokument JSON z 1 boolskim atributom success, ki je nastavljen na true.

Kot primer:

{
    "success":true
}

Nadaljnji poskusi za iskanje imena ali naslova bodo potem uspešni.

Odziv (zlobna zahteva)

Če registracija ni mogoče doseči zaradi napake v zahtevi (formatiranje, manjkajoči atribut itd.), se odziv z statusno kodo 400 Bad Request pošlje klicentu z poljem Content-type, ki je nastavljen kot application/json.

Telo je JSON dokument z 2 atributoma: success, ki je booleanska in error, ki je niz. success je nastavljen na false in error je napolnjen z sporočilom o napaki, ki pojasnjuje napako (in ga je mogoče prikazati v stranki v prihodnosti).

Za nepravično oblikovanje uporabniškega imena bi lahko bil organ:

{
    "success": false,
    "error": "invalid name"
}

Odgovor (prepovedano)

Če registracija ni mogoče doseči, ker je ime že vzela, se odziv z statusno kodo 403 Forbidden pošlje stranki z poljem Content-type, ki je nastavljen kot application/json.

Telo je JSON dokument z 3 atributoma: success, ki je booleanska skupina na false, name in addr, ki sta obe verizi, ki so ponovljeni iz izvirne zahteve.

Če bi se registriranje foobar že registriralo, bi prišlo do naslednjega odgovora:

{
    "success": false,
    "name":"foobar",
    "addr":"0x29347542eb07159fdeadbeefae16243d152f6b7b"
}