REST API – NSSET de dominio

WEDOS REST API está todavía en desarrollo. El acceso y las funciones pueden cambiar sin previo aviso.

Este artículo cubre parcialmente el endpoint Domains de WEDOS REST API. Dominios y Contactos de dominio tienen sus propios artículos. Para WEDOS API (WAPI), consulte WAPI – WEDOS Dominios.

Encontrará información básica sobre WEDOS REST API en el artículo WEDOS REST API Manual.

En este artículo encontrará la siguiente información:

Acceso al endpoint de NSSETs

Un NSSET es un conjunto con nombre de servidores DNS que se puede gestionar de forma independiente y asignar a varios dominios a la vez (se usa sobre todo en los dominios .cz). Esta API cubre la gestión de NSSET bajo el /v2/nssets prefijo de URL.

URL base y autenticación

La URL base de los endpoints de NSSETs es: https://api.wedos.com/v2

Toda la comunicación se realiza mediante HTTPS y la autenticación usa únicamente OAuth2: envíe la cabecera Authorization: Bearer <TOKEN> en cada solicitud. El token debe tener el scope domains (un único scope compartido para dominios, contactos y NSSET). Sin una autenticación válida, la API devuelve un error.

Las solicitudes con datos (POST/PATCH) se envían como JSON (Content-Type: application/json).

Puede añadir el parámetro example=1 a cualquier endpoint (p. ej. ?example=1, o &example=1 si la URL ya contiene otros parámetros de consulta). En lugar de ejecutar la solicitud, la API devuelve entonces un comando curl de ejemplo para esa llamada. Incluso en este modo se requiere una autenticación válida.

Resumen de endpoints

MétodoEndpointDescripción
GET/nssets/checkComprobar la disponibilidad/existencia de un NSSET
GET/nssets/{name}Información del NSSET
POST/nssetsCrear un NSSET
POST/nssets/{name}/transferTransferir un NSSET
POST/nssets/{name}/auth-info/sendEnviar el código de autorización del NSSET
PATCH/nssets/{name}Modificar un NSSET

Formato de la respuesta

La respuesta de la API es siempre un objeto JSON con las claves code (código de retorno), msg (descripción textual), request_id (identificador de la solicitud) y, cuando proceda, data (datos devueltos en caso de éxito).

Además de los códigos de retorno específicos (de negocio) indicados más abajo en cada llamada, todos los endpoints pueden devolver también estos códigos generales de la capa REST:

  • 1000 – la solicitud se ha ejecutado correctamente
  • 2000 – autenticación (token Bearer de OAuth2) ausente o no válida
  • 2004 – se ha superado el tamaño máximo permitido de la solicitud (URL o cuerpo de la solicitud)
  • 4000 – método o acción de la API desconocido o no soportado
  • 4001 – la validación de los datos de entrada ha fallado
  • 4005 – no hay ningún ejemplo definido para la forma de URL actual en el modo example=1 .
  • 6000 – error interno al inicializar el procesamiento de la solicitud

GET /nssets/check

Comprueba si un handle de NSSET está libre para su uso y cuál es su estado en el registro.

Parámetros:

  • tld – obligatorio, query, string – TLD para el que se comprueba el NSSET
  • name – obligatorio, query, string – handle del NSSET
  • reg_key – opcional, query, string – identificador de un registro concreto

Códigos de retorno:

  • 1000 – el NSSET está disponible para registro
  • 2100 – falta un parámetro obligatorio
  • 2101 – parámetros de entrada no válidos
  • 2201 – TLD no válido
  • 2247 – formato de NSSET no soportado
  • 3242 – el NSSET no está disponible
  • 3245 – el NSSET ya está registrado
  • 3248 – NSSET no disponible – cuarentena
  • 3249 – NSSET no disponible – reservado
  • 3250 – NSSET no disponible – bloqueado
  • 3251 – el NSSET ya está registrado con nosotros
  • 4218 – la comprobación ha fallado – error de comunicación
  • 5001 – error interno de autenticación

Datos de la respuesta: Ninguno – el resultado lo transmiten directamente los campos code/msg.

Ejemplo:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/nssets/check?tld=cz&name=NSSET'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g1"
}

GET /nssets/{name}

Devuelve información detallada sobre un NSSET, incluidos sus servidores DNS.

Parámetros:

  • name – obligatorio, path – handle del NSSET
  • tld – obligatorio, query, string – TLD
  • reg_key – opcional, query, string – identificador de un registro concreto

Códigos de retorno:

  • 1000 – OK
  • 2100 – falta un parámetro obligatorio
  • 2101 – parámetros de entrada no válidos
  • 2201 – TLD no válido
  • 2209 – error de sintaxis
  • 2247 – formato de NSSET no soportado
  • 3214 – no se ha podido cargar el NSSET
  • 3242 – el NSSET no está disponible
  • 4204 – error de conexión

Datos de la respuesta:

  • nsset – objeto con los datos del NSSET:
    • name – handle del NSSET
    • status – estado del NSSET en el registro
    • reg_owner, reg_creator, reg_update – identificadores del registrador
    • created_date, updated_date, transfer_date – fechas de creación/actualización/transferencia
    • tech_c – identificador del contacto técnico
    • dns.server – array de los servidores DNS del NSSET (name, addr_ipv4, addr_ipv6)

Ejemplo:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/nssets/NSSET?tld=cz'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g2",
  "data": {
    "nsset": {
      "name": "NSSET",
      "status": "ok",
      "tech_c": "CONTACT",
      "created_date": "2024-01-10",
      "dns": {
        "server": [
          { "name": "ns.wedos.com", "addr_ipv4": null, "addr_ipv6": null },
          { "name": "ns.wedos.org", "addr_ipv4": null, "addr_ipv6": null }
        ]
      }
    }
  }
}

POST /nssets

Crea un NSSET nuevo.

Parámetros:

  • tld – obligatorio, string – TLD para el que se crea el NSSET
  • name – opcional, string – handle de NSSET solicitado; si no se indica, se genera automáticamente
  • dns – obligatorio, array – array de servidores DNS con el formato [{"name":"ns1.example.com","addr_ipv4":"1.2.3.4","addr_ipv6":"..."},...] (addr_ipv4/addr_ipv6 son opcionales para cada servidor; mismo formato que en POST /domains/create)
  • tech_c – opcional, string – identificador del contacto técnico; si no se indica, se usa el predeterminado
  • reg_key – opcional, string – identificador de un registro concreto

Códigos de retorno:

  • 1000 – OK, NSSET creado
  • 2100 – falta un parámetro obligatorio
  • 2101 – formato no válido de los parámetros de entrada
  • 2201 – TLD indicado incorrectamente
  • 2210 – formato no válido del array de servidores DNS
  • 2211 – demasiados servidores DNS
  • 2216 – sintaxis de contacto no válida
  • 2247 – formato de NSSET no soportado
  • 3228 – el registro no admite contactos
  • 3229 – error al cargar el contacto
  • 3242 – el NSSET no está disponible
  • 3244 – la creación del NSSET ha fallado
  • 3245 – el NSSET ya está registrado
  • 4212 – error de conexión
  • 4218, 4219 – la comprobación/creación ha fallado – error de comunicación

Datos de la respuesta:

  • nsset – handle del NSSET creado

Ejemplo:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets' \
  --data '{
    "tld": "cz",
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g3",
  "data": {
    "nsset": "NSSET"
  }
}

POST /nssets/{name}/transfer

Transfiere un NSSET a nosotros desde otro registrador.

Parámetros:

  • name – obligatorio, path – handle del NSSET
  • tld – obligatorio, string – TLD
  • auth_info – obligatorio, string – el código de autorización del NSSET
  • reg_key – opcional, string – identificador de un registro concreto

Códigos de retorno:

  • 1000 – OK
  • 2100 – falta un parámetro obligatorio
  • 2101 – parámetros de entrada no válidos
  • 2201 – TLD no soportado
  • 2215 – auth_info no indicado
  • 2247 – nombre de NSSET no válido
  • 2249 – la transferencia de NSSET no está permitida para este TLD
  • 3214 – no se ha podido cargar el NSSET
  • 3242 – NSSET no soportado
  • 3251 – el NSSET ya está registrado con el registrador de destino
  • 3255 – error de autorización
  • 3256 – la transferencia del NSSET ha fallado
  • 4221 – la transferencia ha fallado – error de conexión

Datos de la respuesta: Ninguno – el resultado lo transmiten directamente los campos code/msg.

Ejemplo:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET/transfer' \
  --data '{"tld": "cz", "auth_info": "AUTHCODE123"}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g4"
}

POST /nssets/{name}/auth-info/send

Envía el código de autorización del NSSET al correo electrónico del contacto técnico.

Parámetros:

  • name – obligatorio, path – handle del NSSET
  • tld – obligatorio, string – TLD
  • reg_key – opcional, string – identificador de un registro concreto

Códigos de retorno:

  • 1000 – OK, código de autorización enviado al correo electrónico de contacto
  • 2100 – falta un parámetro obligatorio
  • 2101 – parámetros de entrada no válidos
  • 2201 – TLD no soportado
  • 2243 – el envío del código de autorización no está permitido para este NSSET
  • 3214 – no se ha podido cargar el NSSET
  • 3217 – el envío del código de autorización ha fallado
  • 3242 – el NSSET no está disponible
  • 4222 – el envío ha fallado – error de conexión
  • 5001 – error interno de autorización

Datos de la respuesta: Ninguno – el resultado lo transmiten directamente los campos code/msg.

Ejemplo:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET/auth-info/send' \
  --data '{"tld": "cz"}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g5"
}

PATCH /nssets/{name}

Modifica un NSSET existente – sus servidores DNS, el contacto técnico o el alcance de las pruebas.

Parámetros:

  • name – obligatorio, path – handle del NSSET
  • tld – obligatorio, string – TLD
  • dns – obligatorio, array – array de servidores DNS con el mismo formato que en POST /nssets
  • auth_info – obligatorio, string – el código de autorización del NSSET
  • tech_c – opcional, string – identificador del contacto técnico; si no se indica, permanece sin cambios
  • reg_key – opcional, string – identificador de un registro concreto
  • report_level – opcional – alcance de las pruebas que el registro realiza durante la modificación

Códigos de retorno:

  • 1000 – OK
  • 2100 – falta un parámetro obligatorio
  • 2101 – parámetros de entrada no válidos
  • 2201 – TLD indicado incorrectamente
  • 2209 – error de sintaxis
  • 2210 – formato no válido del array de servidores DNS
  • 2211 – demasiados servidores DNS
  • 2216 – sintaxis de contacto no válida
  • 2247 – NSSET no válido
  • 3214 – no se ha podido cargar el NSSET
  • 3242 – este dominio/registro no admite el NSSET
  • 3252 – error de autorización
  • 3254 – la modificación del NSSET ha fallado
  • 4204, 4220 – NSSET no disponible/la modificación ha fallado – error de conexión
  • 4212 – contacto no disponible – error de conexión

Datos de la respuesta: Ninguno – el resultado lo transmiten directamente los campos code/msg.

Ejemplo:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET-1' \
  --data '{
    "tld": "cz",
    "auth_info": "AUTHCODE123",
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g6"
}

Notas

  • Los endpoints bajo /v2/domains, /v2/contacts y /v2/nssets los gestiona una única clase de servidor compartida y todos comparten un mismo scope de OAuth2, domains. Desde el punto de vista del cliente, son tres API lógicamente separadas, pero unificadas administrativamente.
  • El parámetro dns se indica como un array simple de objetos {"name": "...", "addr_ipv4": "...", "addr_ipv6": "..."}. Internamente se convierte al formato legacy que usan las versiones anteriores de la API antes de la llamada WAPI. Los elementos addr_ipv4 y addr_ipv6 son opcionales para cada servidor.
  • En los NSSET, tld es siempre un parámetro obligatorio, porque el mismo handle (name) puede existir en teoría en varios registros y la validación/el formato de los datos difieren según el TLD/registro.

¿Le ha resultado útil?

¡Gracias por su valoración!
Selectores genéricos
Solo coincidencias exactas
Buscar en el título
Buscar en el contenido
Selectores de tipo de entrada
Índice del artículo
Explorar categorías