RDAP - Descripción de la API
RDAP - API
Introducción
Este documento explica cómo acceder a los servicios RDAP de Lacnic, y el contenido de dichos servicios. Todos los servicios de RDAP son de sólo-lectura y se acceden a través del método HTTP GET, por el momento no es posible hacer consultas con otros métodos HTTP o realizar escrituras en el sistema a través de estos servicios. Los servicios se pueden acceder según la especificación del documento RDAP Query. La respuesta generada se encuentra en formato JSON, conforme con las especificaciones de RDAP JSON Repsonse. Más información y algunos ejemplos de las mismas se muestran a lo largo de este documento.
NOTA Un parámetro opcional que es transversal a todo el sistema es el parámetro por URI llamado apikey. El apikey es un token que se puede solicitar para acceder a servicios extendidos de Lacnic, como por ejemplo bulk RDAP (análogo a bulk whois). Para pedir su apikey, por favor siga las instrucciones en el sitio de Documentos para Registro. RDAP acepta este parámetro para identificar y autorizar al usuario, permitiéndole acceder a sus servicios. Por ejemplo, la URI
http://mi.sitio/servicio?apikey=hf78363ghd7d6d4a0ajdy463
indica que el usuario identificado con el token hf78363ghd7d6d4a0ajdy463, quiere acceder a los servicios asociados a ese token.
Glosario
API | Application Programming Interface |
API Key | Identificador de usuario para usar una API |
Entidades | Organizaciones o personas físicas |
Bloques | Bloques IP asignados por Lacnic |
Sistema Autónomo | Uno o más operadores que intercambian información del ruteo externo |
Dominio | Nombre de dominio a través del cual se accede a un recurso. En particular, los dominios abarcados por el RDAP de Lacnic se limitan a los dominios bajo las zonas in-addr.arpa e ip6.arpa |
Nameserver | Nombres de servidores DNS |
Consulta DNS Reversa | Es la consulta que permite determinar el nombre de dominio a partir de una dirección IP |
Servidor DNS Reverso | Servidor encargado de resolver consultas DNS reversas |
Acerca de la notación
En caso de ofrecer un ejemplo, el formato del mismo es el siguiente
negrita | Es un valor estándar en la respuesta. La respuesta JSON siempre tendrá este valor. |
<campo> |
Es el contenido del campo, y varía según la consulta que se haga. Puede tomar cualquier valor. |
<opción_1 | opción_2 | opción_3> |
Es el contenido del campo, y puede tomar los valores opción_1, opción_2, u opción_3 únicamente. |
<referencia> |
Es una referencia a una estructura definida previamente. Por ejemplo, se puede hacer referencia a una estructura elemental. |
[ <referencia> ] |
Es una lista de referencias a estructuras definidas previamente. Puede contener uno o más de un elemento, o estar vacía. |
Algunas estructuras elementales
vcardArray
[ "vcard",
[
[ "version", { }, "text", "4.0" ],
[ "fn", { }, "text", <nombre> ],
[ "kind", { }, "text", <tipo> ],
[ "adr", { "label" : <dirección> }, "text", null ],
[ "tel", { "type" : "voice" }, "text", <número_telefónico> ],
[ "tel", { "type" : "fax" }, "text", <fax> ],
[ "email", { }, "text", <correo_electrónico> ] ]
]
rol
<administrative | technical | registrant | billing>
enlace
"value" : "http://...",
"rel" : <contenido_del_enlace>,
"href" : "http://..."
país
< ISO_Country_Code >
lang
< SP | PT | FR | EN >
ipVersion
< v4 | v6 >
network
< CIDR_network_prefix >
entity
{
"handle" : <handle>,
"vcardArray" : <vcardArray>,
"roles" : [ <rol> ],
"networks" : [ <network> ],
"lang" : <lang>
}
nameserver
{
"handle" : <handle>,
"ldhName" : <ldhName>,
"unicodeName" : <nombre_unicode>,
"entities" : [ <entity> ]
}
notificación
{
"title" : <título>,
"description" : [ <descripción> ],
"links" : [ <link> ]
}
Descripción de los Servicios
Búsqueda por índice
Entidades
Campo | Valor / Descripción
–|–
URL | /entity/<handle>
<handle>
| Identificador de la entidad de la que se quiere obtener más información.
{
"handle" : <handle>,
"vcardArray" : <vcardArray>,
"roles" : [ <rol> ],
"networks" : [ <network> ],
"autnums" : [ <autnum> ],
"entities" : [ <contacto_administrativo>, <contacto_membresía>, <contacto_facturación>],
"links" : [ <enlace> ],
"events" : [ <evento> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
Bloques
Campo | Valor / Descripción
–|–
URL | /ip/<handle>
<handle>
| Dirección IP o bloque CIDR con largo de prefijo de la que se quiere obtener más información.
{
"handle" : <handle>,
"startAddress" : <ip_inicial>,
"endAddress" : <ip_final>,
"ipVersion" : <ipVersion>,
"name" : <nombre>,
"type" : "assigned",
"country" : <pais>,
"entities" : [ <contacto_administrativo>, <contacto_técnico>, <contacto_abuso>, <organización>],
"links" : [ <enlace> ],
"events" : [ <evento> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
Sistemas Autónomos
Campo | Valor / Descripción
–|–
URL | /autnum/<handle>
<handle>
| Número autónomo del Sistema Autónomo del que se quiere obtener más información.
{
"handle" : <asn>,
"startAutnum" : <asn_inicio>,
"endAutnum" : <asn_fin>,
"name" : <nombre>,
"type" : "DIRECT ALLOCATION",
"networks" : [ <network> ],
"entities" : [ <entity> ],
"remarks" : <remarks>,
"links" : [ <enlace> ],
"events" : [ <evento> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
Nameservers
Campo | Valor / Descripción
–|–
URL | /nameserver/<handle>
<handle>
| Nombre del nameserver del que se quiere obtener más información.
{
"handle" : <handle>,
"ldhName" : <handle>,
"nameServers" : [ <nameServer> ],
"entities" : [ <entity> ],
"links" : [ <enlace> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
DNS Reverso
Campo | Valor / Descripción
–|–
URL | /domain/<domain>
<domain>
| Nombre de dominio (en particular, bajo las zonas in-addr.arpa o ip6.arpa) del cual se quiere saber más información
{
"handle" : <handle>,
"ldhName" : <ldhName>,
"nameServers" : [ <nameServer> ],
"entities" : [ <entity> ],
"links" : [ <enlace> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
Búsqueda por metacaracteres
El servicio de búsqueda por metacaracteres permite insertar metacaracteres en los campos de búsqueda, y así poder realizar búsquedas más flexibles. Este servicio se limita a 20 resultados por búsqueda. Entidades
Campo | Valor / Descripción
–|–
URL | /entities?handle=<handle>
<handle>
| Identificador (completo o con metacaracteres) de la entidad de la que se quiere obtener más información.
{
"entitySearchResults" : [ <entity> ],
"links" : [ <enlace> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
Campo | Valor / Descripción
–|–
URL | /entities?name=<name>
<name>
| Nombre (completo o con metacaracteres) de la entidad de la que se quiere obtener más información.
{
"entitySearchResults" : [ <entity> ],
"links" : [ <enlace> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
Nameservers
Campo | Valor / Descripción
–|–
URL | /nameservers?name=<name>
<name>
| Nombre (completo o con metacaracteres) del nameserver que se quiere obtener más información
{
"nameserverSearchResults" : [ <nameServer> ],
"links" : [ <enlace> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}
Campo | Valor / Descripción
–|–
URL | /nameservers?ip=<ip>
ip
| Dirección IP o rango CIDR del cual se quiere obtener información acerca de quién lo resuelve
{
"nameserverSearchResults" : [ <entity> ],
"links" : [ <enlace> ],
"rdapConformance" : [ "rdap_level_0" ],
"notices" : [ <notificación> ],
"port43" : "whois.lacnic.net"
}