Adı Server protokolü

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.

The public name server is hosted at ns.jami.net. Another implementation could use any other database or directory service making the name server protocol reusable.

If you run your own name server, looking up a username in the form of username@example.com will look up the name username with the name server at example.com (there is no need to add @ns.jami.net to use the default name server).

Ad biçimlendirme kuralları

Kullanıcı isimleri, formatları hakkında bazı kurallar sağlamak için regex tarafından kontrol edilir:

  • Uzunluk 3 ile 32 karakter arasında olmalıdır.

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

Bir isim sormak

Bu bir isim sunucusu tarafından sağlanan ana hizmet. Bir kullanıcı adına karşılık gelen Jami Kimliğini elde etmeni sağlar.

Request name

A request for the name foobar is a GET request with /name/foobar* as the URI.

Response name (Success)

If the name is found, a response with status code 200 OK must be sent to the client with a Content-type field set as application/json.

The body is a JSON documents with 2 string attributes : name and addr. name is equal to the one requested and addr is a hexadecimal representation of the Jami ID prefixed with 0x.

Örnekte JSON cevabı şöyle olacaktır:

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

Response name (Not found)

If the name is not found, a response with status code 404 Not Found must be sent to the client with a Content-type field set as application/json.

Bu özellik, hatayı açıklayan bir hata mesajıyla (ve gelecekte istemcide görüntülenebilir) doldurulur.

Referans uygulanması ile ilgili olarak, geri gönderilen belge:

{
    "error":"name not registred"
}

Adres sorgulaması

Bu hizmet ters bir arama. Adres sorarsanız bir kullanıcı adı adı sunucusunda kayıtlı ise geri verilir.

Request address

A request for the ID jami:29347542eb07159f316577e1ae16243d152f6b7b is a GET request with /addr/29347542eb07159f316577e1ae16243d152f6b7b as the URI.

Response address (Success)

If the address corresponds to a username, a response with status code 200 OK must be sent to the client with a Content-type field set as application/json.

Bu alanın değeri bu adreste kayıtlı olan isimdir.

Örnekte JSON cevabı şöyle olacaktır:

{
    "name":"foobar"
}

Response address (Not found)

If the address is not found, a response with status code 404 Not Found must be sent to the client with a Content-type field set as application/json.

Bu özellik, hatayı açıklayan bir hata mesajıyla (ve gelecekte istemcide görüntülenebilir) doldurulur.

Referans uygulanması ile ilgili olarak, geri gönderilen belge:

{
    "error":"address not registred"
}

Bir isim kaydetmek

Protokolün bu kısmı yeni bir isim/ağıt çiftini kaydetmek için kullanılır. Ana kamu kayıtlarında kullanılır, ancak özel bir uygulamada seçkin olabilir.

Request register

foobar adı kayıt için bir talep POST /name/*foobar* olarak URI'dir. Başlık özelliği Content-type application/json olarak ayarlanmalıdır.

İstek gövdesinde 2 satırlı bir JSON belgesidir: addr ve owner. addr, 0x ve owner ile önceden belirtilen Jami ID içerir.

foobar için bir örnek:

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

Response register (Success)

If the name/address pair is successfully registered, a response with status code 200 OK must be sent to the client with a Content-type field set as application/json.

Beden, 1 boolean özelliği success ile true olarak ayarlanmış bir JSON belgesini içerir.

Örnek olarak:

{
    "success":true
}

Adı veya adresi sormak için daha fazla girişim başarılı olmalıdır.

Response register (Bad request)

If the registration cannot be achieved because of an error in the request (formatting, missing attribute, etc.), a response with status code 400 Bad Request must be sent to the client with a Content-type field set as application/json.

Vücut, 2 özelliğe sahip bir JSON belgesidir: success bu bir boolean ve error bu bir dizilerdir. success falseveerror` olarak ayarlanmıştır.

Kullanıcı adının geçersiz biçimlendirilmesi için, vücut:

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

Response register (Forbidden)

If the registration cannot be achieved because the name is already taken, a response with status code 403 Forbidden must be sent to the client with a Content-type field set as application/json.

Vücut, 3 özelliği olan bir JSON belgesidir: success, bu da orijinal istekten çoğaltılan her iki ip olan false, name ve addr’ye boolean bir seti.

Bu kayıt, zaten kayıtlı olduğu için aşağıdaki tepkiye yol açacaktır:

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