Izenaren zerbitzari protokoloa

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.

Izen zerbitzari publikoa ns.jami.net-en dago gordeta eta bloke bat erabiltzen du bere atzeko mutur gisa. Beste inprogramazio batek edozein datu base edo kaxa zerbitzu erabili ahal izango luke, izen zerbitzariaren protokoloa erabilgarria bihurtzen baitu.

Zure izena zerbitzari propioa bada, username@example.com-en erabilera-izenaren bila, username-a bilatuko duzu username.com-en izen zerbitzariarekin.

Izen formateatzeari buruzko arauak

Erabiltzaileen izenak regex batek egiaztatzen ditu, formatuaz hitz egiteko arau batzuk ziurtatzeko:

  • Luzera 3 eta 32 karaktere artean egon behar du.

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

Izen bat eskatzen.

Izen zerbitzari batek ematen duen zerbitzu nagusia da.

Eskari bat

Izenaren eskaria foobar da GET eskaria /name/foobar URI gisa.

Erantzuna (Erakutsi)

Izen hori aurkitzen bada, erantzun bat bidali behar zaio bezeroari, non ``content-typeeremu bat dago,application/json` bezala ezarria.

Gorputza JSON dokumentu bat da, bi string atributu dituena: name eta addr. name eskatutakoarekin bat dator eta addr Jami IDren sei hamarren mailako errepresentazioa da, 0x izenarekin aurreztua.

Gure adibidean, JSONren erantzuna izango litzateke:

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

Erantzuna (ez dago aurkitu)

Izenak ez badu aurkitzen, egoera kodearekin erantzun bat bidali behar zaio bezeroari 404 Not Found, eta Content-type eremu bat jarri zaio application/json.

JSON dokumentu bat da eta hari lotutako atributu bat du: error. Atributu hau akats mezu batekin betetzen da, akatsaren azalpena azaltzen duena (eta etorkizunean bezeroan ikus daiteke).

Erreferentziazko gauzatzeari buruz, itzultzen den dokumentuak:

{
    "error":"name not registred"
}

Helbide bat bilatzen

Zerbitzu hau atzera begiratzen da. Helbide bat eskatzen duzu eta erabiltzaile izena itzultzen da izen zerbitzarian erregistratzen bada.

Eskari bat

ID jami:29347542eb07159f316577e1ae16243d152f6b7b GETeskaera da/addr/*29347542eb07159f316577e1ae16243d152f6b7b`* URI gisa.

Erantzuna (Erakutsi)

Helbideak erabiltzaile izen bat du, eta helbideak erabiltzaile izena du, erantzun bat bidali behar zaio bezeroari, eta bertan content-typeeremua jarri behar daapplication/json`.

JSON dokumentu bat da eta jatorri bateko atributu bat du: name.

Gure adibidean, JSONren erantzuna izango litzateke:

{
    "name":"foobar"
}

Erantzuna (ez dago aurkitu)

Helbidea ez bada aurkitzen, egoera kodearekin erantzun bat bidali behar zaio bezeroari 404 Not Found, eta Content-type eremu bat jarri behar zaio application/json.

JSON dokumentu bat da eta hari lotutako atributu bat du: error. Atributu hau akats mezu batekin betetzen da, akatsaren azalpena azaltzen duena (eta etorkizunean bezeroan ikus daiteke).

Erreferentziazko gauzatzeari buruz, itzultzen den dokumentuak:

{
    "error":"address not registred"
}

Izen bat erregistratzea

Protokoloaren zati hau izen/heli bikote berri bat erregistratzeko erabiltzen da. Erregistro publiko nagusian erabiltzen da, baina opzionala izan daiteke pertsonalizatutako martxan jartzean.

Eskari bat

Izenaren erregistroa egiteko eskaera foobar da POST eskaera /name/foobar URI gisa.

Eskariaren gorputza JSON dokumentu bat da, bi string atributuekin: addr eta owner. addr Jami ID du izena izenaz betea.

foobar adibide bat izan daiteke:

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

Erantzuna (Erakutsi)

Izen-abizen bikotea arrakastatsua izan bada, egoera-kodea duen erantzuna 200 OK bidali beharko zaio bezeroari Content-type eremu batekin application/json bezala ezarria.

Gorputzak JSON dokumentu bat du 1 boolean atributu success egia.

Adibidez:

{
    "success":true
}

Izen edo helbidea galdetzeko beste saiakera arrakastatsua izan beharko litzateke.

Erantzun txarra (eskabide txarra)

Erregistroa ezin bada lortu eskaeran akats bat (formatze, falta den atributu, eta abar) dela eta, erantzun bat bidali behar zaio bezeroari, non eskabide-motzeko `` erantzuna application/json bezala ezarria den.

JSON dokumentu bat da, bi ezaugarri dituena: success, bolea eta error, hari bat dena. success, false eta error izendatuta dago, eta akatsaren azalpena azaltzen duen akats mezu batekin betea dago (eta etorkizunean bezeroan erakutsi daiteke).

Erabiltzaile-izenaren formatua ez badabil, gorputza izan daiteke:

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

Erantzun (debekatuta)

Erregistroa ezin bada lortu izena hartu delako, erantzun bat bidali behar zaio bezeroari, estatu kodearekin 403 Forbidden, Content-type eremu batekin, application/json bezala ezarria.

JSON dokumentu bat da, 3 ezaugarri dituena: success, zeinak boolean multzo bat diren false, name eta addr, biak jatorrizko eskaeratik errepikatu diren hariak direnak.

Erregistratzeak, dagoeneko erregistratua dagoenez, ondorengo erantzun hau ekarriko luke:

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