Nimi Server protokoll

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.

Üldine nimeserver on hoitud ns.jami.net ja kasutab oma tagaküljel blockchain. Teine rakendus võib kasutada kõiki muid andmebaasi või direktoriumi teenuseid, mis muudavad nimeserver protokolli taaskasutatavaks.

Kui te kasutate oma nime serverit, otsite kasutajanimi username@example.com vormis, otsite nime username koos nime serveriga example.com. (Ette vaja lisada @ns.jami.net et kasutada oletatud nime serverit.)

Nimi vormingu eeskirjad

Kasutajainimed kontrollitakse regex’i poolt, et tagada nende formaadi kohta mõned reeglid:

  • Pikkus peab olema 3 kuni 32 karakteri vahel

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

Küsimus nime kohta

See on nimi server pakutav peamine teenus, mis võimaldab saada Jami ID, mis vastab kasutajanimele.

Nõue

foobar (t) GET (t) /name/foobar (t) URI (t)

Reageerimine (suus)

Kui nimi leiti, tuleb kliendile saata vastus, mille staatuskodu on 200 OK, mille puhul on Content-type vald application/json.

JSON-dokumendid, millel on 2 järjekorda: name ja addr. name võrdub taotletud dokumentiga ja addr on Jami ID hexadecimaline esindus, millele on ette nähtud 0x.

Meie näites oleks JSON vastus:

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

Vastust (ei leitud)

Kui nime ei leidu, tuleb kliendile saata vastus, mille staatuskodu on 404 Not Found, mille puhul on Content-type vald, mis on määratud application/json.

JSON-dokumendid on JSON-dokumendid, millel on 1 järjekordne attribüüt: error. See attribüüt on täidetud vigamise sõnumiga, mis selgitab viga (ja seda võib tulevikus kliendil näidata).

Referentsite rakendamise kohta tagastatakse dokumend:

{
    "error":"name not registred"
}

Adressi küsimine

See teenus on pöördvaataht. Te küsite aadressi ja kasutajanimi saadakse tagasi, kui üks on registreeritud nime serveris.

Nõue

ID jami:29347542eb07159f316577e1ae16243d152f6b7b taotlus on GET taotlus, mille URI on /addr/29347542eb07159f316577e1ae16243d152f6b7b`

Reageerimine (suus)

Kui aadress vastab kasutajanimeele, tuleb kliendile saata vastus, mille seisukood on 200 OK, millel on Content-type vald, mis on määratud application/json.

JSON-dokumendid, millel on 1 järjekordne tunnus: name. Selle välja väärtus on selles aadressi registreeritud nimi

Meie näites oleks JSON vastus:

{
    "name":"foobar"
}

Vastust (ei leitud)

Kui aadress ei leidu, tuleb kliendile saata vastus, mille staatuskodu on 404 Not Found, millel on Content-type vald, mis on määratud application/json.

JSON-dokumendid on JSON-dokumendid, millel on 1 järjekordne attribüüt: error. See attribüüt on täidetud vigamise sõnumiga, mis selgitab viga (ja seda võib tulevikus kliendil näidata).

Referentsite rakendamise kohta tagastatakse dokumend:

{
    "error":"address not registred"
}

Nimi registreerimine

Seda protokolli osa kasutatakse uue nime/aadressi paari registreerimiseks.

Nõue

Nimi registreerimise taotlus foobar on POST taotlus, mille URI on /name/foobar.Üleheegistus Content-type peab olema seadistatud application/json.

Taotluse keha on JSON-dokumend, millel on 2 järjekorda: addr ja owner. addr sisaldab Jami ID, mille eesnäiteks on 0x ja owner on registreeritava nimi.

foobar võib olla näiteks:

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

Reageerimine (suus)

Kui nimi-adresside paar on edukalt registreeritud, tuleb kliendile saata vastus, mille staatuskodu on 200 OK, mille puhul on Content-type vald application/json.

Korpus sisaldab JSON-dokumendi, millel on 1 boolean-attribuut success, mis on määratud true.

Näiteks:

{
    "success":true
}

Järgmised üritused nime või aadressi küsida peaks olema edukad.

Vastus (ebaaus taotlus)

Kui registreerimist ei saa teha taotluse (formateerimise, puudub attribüüt jne) viga tõttu, tuleb kliendile saata vastus, mille staatuskodu on 400 Bad Request, millel on Content-type välja, mis on määratud application/json.

JSON-dokumendid on 2 tunnusega: success, mis on booliane ja error, mis on string. success on seadistatud false ja error on täis vigu sõnumit, mis selgitab vigu (ja seda võib tulevikus kliendil näidata).

Kasutaja nime kehtetuks vorminguks võib keha olla:

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

Vastus (keelatud)

Kui registreerimist ei saa teha, kuna nimi on juba võetud, tuleb kliendile saata vastus staatuskoduga 403 Forbidden, millel on Content-type välja, mis on määratud application/json.

JSON-dokumendid on 3 tunnusega: success, mis on boolean set false, name ja addr, mis on mõlemad reedid, mis on replitseeritud algsest taotlusest.

Registreerimine foobar, kui see on juba registreeritud, toob kaasa järgmise vastuse:

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