Nombre Protocolo del servidor
El protocolo utilizado por Jami para consultar y registrar un nombre se basa en un HTTP REST API respondiendo solicitudes con documentos JSON y códigos de estado HTTP regulares.
El servidor de nombres públicos está alojado en `ns.jami.net”. Otra implementación podría usar cualquier otra base de datos o servicio de directorio que haga reutilizable el protocolo del servidor de nombres.
Si ejecuta su propio servidor de nombres, busque un nombre de usuario en forma de username@example.com 'buscará el nombre' nombre de usuario 'con el servidor de nombres en
example.com `(no es necesario agregar “@ns.jami.net “ para usar el servidor de nombres predeterminado).
Reglas sobre el formato de los nombres
Los nombres de usuario son verificados por un regex para asegurar algunas reglas sobre su formato:
La longitud debe ser de entre 3 y 32 caracteres
Estos caracteres deben ser alfanuméricos y también debe aceptarse el guión
-
.
Buscando un nombre
Este es el servicio principal proporcionado por un servidor de nombres.
Nombre de la solicitud
Una solicitud para el nombre “foobar” es una solicitud “ GET “con `/name/foobar”* como URI.
Nombre de la respuesta (Éxito)
Si se encuentra el nombre, se debe enviar una respuesta con el código de estado “200 OK” al cliente con un campo “Content-type” establecido como “application/json”.
El cuerpo es un documento JSON con 2 atributos de cadena “name” y “address”. “name” es igual al solicitado y “addr” es una representación hexadecimal del ID Jami con el prefijo “0x”`.
En nuestro ejemplo, la respuesta JSON sería:
{
"name":"foobar",
"addr":"0x29347542eb07159f316577e1ae16243d152f6b7b"
}
Nombre de la respuesta (No encontrado)
Si no se encuentra el nombre, se debe enviar una respuesta con el código de estado `404 Not Found “al cliente con un campo” Content-type “establecido como” application/json”.
El cuerpo es un documento JSON con un atributo de cadena: error
. Este atributo está lleno de un mensaje de error que explica el error (y podría mostrarse en el cliente en el futuro).
En relación con la ejecución de referencia, el documento devuelto será:
{
"error":"name not registred"
}
Buscando una dirección
Este servicio es una búsqueda inversa. Usted consulta una dirección y un nombre de usuario se devuelve si uno está registrado en el servidor de nombres.
Dirección de solicitud
Una solicitud para el ID “jami:29347542eb07159f316577e1ae16243d152f6b7b” es una solicitud GET' con
/addr/29347542eb07159f316577e1ae16243d152f6b7b` as the URI.
Dirección de respuesta (Éxito)
Si la dirección corresponde a un nombre de usuario, se debe enviar una respuesta con el código de estado `200 OK” al cliente con un campo “Content-type” configurado como “application/json”.
El cuerpo es un documento JSON con un atributo de cadena: name
. El valor de este campo es el nombre registrado en esta dirección
En nuestro ejemplo, la respuesta JSON sería:
{
"name":"foobar"
}
Dirección de respuesta (No encontrada)
Si no se encuentra la dirección, se debe enviar una respuesta con el código de estado `404 Not Found” al cliente con un campo “Content-type” establecido como “application/json”.
El cuerpo es un documento JSON con un atributo de cadena: error
. Este atributo está lleno de un mensaje de error que explica el error (y podría mostrarse en el cliente en el futuro).
En relación con la ejecución de referencia, el documento devuelto será:
{
"error":"address not registred"
}
Registro de un nombre
Esta parte del protocolo se utiliza para registrar un nuevo par de nombres/direcciones.
Solicitar registro
Una solicitud de registro del nombre foobar
es una solicitud POST
con /name/
foobar
como URI. El atributo de encabezado Content-type
debe fijarse en application/json
.
El cuerpo de la solicitud es un documento JSON con 2 atributos de cadena: addr
y owner
. addr
contiene el ID Jami prefijado con 0x
y owner
es el nombre que debe registrarse.
Un ejemplo de foobar
podría ser:
{
"addr":"0x29347542eb07159f316577e1ae16243d152f6b7b",
"owner":"foobar"
}
Registro de respuestas (Éxito)
Si el par nombre/dirección se registra correctamente, se debe enviar una respuesta con el código de estado “200 OK” al cliente con un campo “Tipo de contenido” establecido como “application/json”.
El cuerpo contiene un documento JSON con 1 atributo booleano success
fijado en true
.
Como ejemplo:
{
"success":true
}
Los intentos adicionales de consultar el nombre o la dirección deberían entonces tener éxito.
Registro de respuesta (Solicitud incorrecta)
Si el registro no se puede lograr debido a un error en la solicitud (formato, atributo incompleto, etc.), se debe enviar una respuesta con el código de estado “400 Bad Request” al cliente con un campo` Content-type “establecido como “application/json”.
El cuerpo es un documento JSON con 2 atributos: success
que es un boolean y error
que es una cadena. success
se establece en false
y error
se llena de un mensaje de error que explica el error (y podría mostrarse en el cliente en el futuro).
Para un formato inválido del nombre de usuario, el cuerpo podría ser:
{
"success": false,
"error": "invalid name"
}
Registro de respuestas (Prohibido)
Si no se puede lograr el registro porque el nombre ya está tomado, se debe enviar una respuesta con el código de estado 403 Prohibido ' al cliente con un campo
Tipo de contenido” configurado como “application/json”.
El cuerpo es un documento JSON con 3 atributos: success
que es un conjunto booleano de false
, name
y addr
que son ambas cadenas replicadas de la solicitud original.
El registro de foobar
, ya que ya está registrado, daría lugar a la siguiente respuesta:
{
"success": false,
"name":"foobar",
"addr":"0x29347542eb07159fdeadbeefae16243d152f6b7b"
}
Algunos enlaces
: implementación de referencia de NodeJS utilizada por
ns.jami.net
y haciendo consultas a un nodo de Ethereum.