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 NSSETs tienen sus propios artículos. Para WEDOS API (WAPI), consulte WAPI – WEDOS Contactos de dominio.
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 DNS
- Detalles del endpoint DNS:
- Notas
Acceso al endpoint de contactos
Esta API cubre la gestión de los contactos de dominio bajo el /v2/contacts prefijo de URL. En los contactos debe indicar siempre el TLD, porque el formato y la validación de los datos del contacto difieren según el registro al que pertenece el TLD.
URL base y autenticación
La URL base de los endpoints de contactos 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étodo | Endpoint | Descripción |
|---|---|---|
| GET | /contacts/check | Comprobar la disponibilidad/existencia de un contacto |
| GET | /contacts/{cname} | Información del contacto |
| POST | /contacts/create | Crear un contacto nuevo |
| POST | /contacts/{cname}/transfer | Transferir un contacto |
| POST | /contacts/{cname}/auth-info/send | Enviar el código de autorización del contacto |
| PATCH | /contacts/{cname} | Modificar un contacto |
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 correctamente2000– autenticación (token Bearer de OAuth2) ausente o no válida2004– 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 soportado4001– la validación de los datos de entrada ha fallado4005– no hay ningún ejemplo definido para la forma de URL actual en el modoexample=1.6000– error interno al inicializar el procesamiento de la solicitud
GET /contacts/check
Comprueba si un handle de contacto 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 contactocname– obligatorio, query, string – handle (identificador) del contactoreg_key– opcional, query, string – identificador de un registro concreto (si el TLD admite varios registros/modos)
Códigos de retorno:
1000– el contacto está libre y se puede usar2201– TLD no válido2216– formato no válido del identificador de contacto2218– en este registro los contactos se generan automáticamente (no puede elegir el handle)3228– el registro no admite contactos3231– el contacto ya existe3233– el contacto no se puede usar3234– el contacto no se puede usar – cuarentena3235– el contacto no se puede usar – reservado3236– el contacto no se puede usar – bloqueado3237– el contacto ya está registrado con nosotros4211– la comprobación del contacto ha fallado – error de conexió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/contacts/check?tld=eu&cname=CONTACT'
{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3f1"
}
GET /contacts/{cname}
Devuelve información detallada sobre un contacto.
Parámetros:
cname– obligatorio, path – handle del contactotld– obligatorio, query, string – TLD bajo el que se busca el contactoauth_info– opcional, query, string – el código de autorización del contacto (si se indica, debe coincidir con el código establecido en el objeto; de lo contrario se devuelve un error)reg_key– opcional, query, string – identificador de un registro concreto
Códigos de retorno:
1000– OK2201– TLD indicado incorrectamente2216– error de sintaxis del identificador de contacto3215– código de autorización no válido (se ha indicado y no coincide)3228– el registro no admite contactos3229– error al cargar el contacto3236– el contacto está bloqueado4212– error de conexión5001– no hay ninguna sesión iniciada
Datos de la respuesta:
contact– objeto con los datos del contacto:contact_id,roid,status– identificador, ROID y estado del contacto en el registroname,fname,lname,company– nombre/nombre de pila/apellidos, o razón socialaddr_street,addr_city,addr_zip,addr_state,addr_country– direcciónphone,fax,email,email2– datos de contactoic,dic,taxpayer– identificación de empresa (IČ), identificación fiscal (DIČ), condición de pagador del IVAreg_owner,reg_creator,reg_update– identificadores del registradorcreated_date,updated_date,transfer_date– fechas de creación/actualización/transferenciadisclose– configuración de divulgación de datos (según el registro)other– datos adicionales específicos del registro
Ejemplo:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/contacts/CONTACT?tld=eu'
{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3f2",
"data": {
"contact": {
"contact_id": "CONTACT",
"status": "ok",
"fname": "Esmeralda",
"lname": "Excavadora",
"company": null,
"addr_street": "Street 123",
"addr_city": "City",
"addr_zip": "11000",
"addr_country": "CZ",
"phone": "+420.777123456",
"email": "esmeralda@wedos.com",
"created_date": "2024-01-10",
"updated_date": null
}
}
}
POST /contacts/create
Crea un contacto de dominio nuevo para el TLD indicado.
Parámetros:
tld– obligatorio, string – TLD para el que se crea el contactoreg_key– opcional, string – identificador de un registro concretocontact– obligatorio, object – datos del contacto; los campos disponibles difieren según el registro, normalmente:cname(opcional) – handle de contacto solicitado; omítalo en los registros que generan los handles automáticamentefname,lname– nombre y apellidos (para una persona física)company– razón social (para una persona jurídica)addr_street,addr_city,addr_zip,addr_state,addr_country– direcciónphone,fax,email,email2– datos de contactoic,dic,taxpayer– identificación de empresa (IČ), identificación fiscal (DIČ), condición de pagador del IVA- otros elementos según el registro concreto
Códigos de retorno:
1000– contacto creado2100– falta un parámetro obligatorio2101– parámetros de entrada no válidos2201– TLD no válido2216– nombre de contacto no válido2218– en este registro los nombres de contacto se crean automáticamente (no puede indicar uno propio)2219–2242– faltan elementos concretos del contacto o su formato no es válido (razón social, nombre, apellidos, correo electrónico, teléfono, fax, identificación de empresa, identificación fiscal, dirección, región, otros datos)3228– el registro no admite contactos3230– la creación del contacto ha fallado3231– el nombre de contacto ya está en uso3233– el contacto no se puede usar3234– el contacto no se puede usar – cuarentena3236– el contacto no se puede usar – bloqueado3237– el contacto ya está registrado con nosotros4211– la comprobación ha fallado – error de comunicación4213– la creación del contacto ha fallado – error de comunicación
Datos de la respuesta:
cname– handle del contacto creado
Ejemplo:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/contacts/create' \
--data '{
"tld": "eu",
"contact": {
"fname": "Esmeralda",
"lname": "Excavadora",
"addr_street": "Street 123",
"addr_city": "City",
"addr_zip": "11000",
"addr_country": "CZ",
"email": "esmeralda@wedos.com",
"phone": "+420.777123456"
}
}'
{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3f3",
"data": {
"cname": "CONTACT"
}
}
POST /contacts/{cname}/transfer
Transfiere un contacto a nosotros desde otro registrador (solo en los registros que admiten la transferencia de contactos, p. ej. CZ.NIC).
Parámetros:
cname– obligatorio, path – handle del contactotld– obligatorio, string – TLDauth_info– obligatorio, string – el código de autorización del contactoreg_key– opcional, string – identificador de un registro concreto
Códigos de retorno:
1000– OK2100– falta un parámetro obligatorio2101– parámetros de entrada no válidos2201– TLD no válido2215– parámetroauth_infono indicado2216– identificador de contacto no válido2244– este dominio/registro no admite la transferencia de contactos3229– el contacto no está disponible3237– el contacto ya está registrado con nosotros3240– error de autorización3241– la transferencia ha fallado4216– 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/contacts/CONTACT/transfer' \
--data '{"tld": "cz", "auth_info": "AUTHCODE123"}'
{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3f4"
}
POST /contacts/{cname}/auth-info/send
Envía el código de autorización del contacto a su correo electrónico de contacto.
Parámetros:
cname– obligatorio, path – handle del contactotld– obligatorio, string – TLDreg_key– opcional, string – identificador de un registro concreto
Códigos de retorno:
1000– OK2100– falta un parámetro obligatorio2101– parámetros de entrada no válidos2201– TLD no válido2216– nombre de contacto no válido2243– el envío del código de autorización no está permitido para este contacto3213– el contacto no está disponible3215– el envío del código ha fallado3228– el registro no admite contactos4217– el envío ha fallado – error de comunicación5001– error de autenticació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/contacts/CONTACT/auth-info/send' \
--data '{"tld": "eu"}'
{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3f5"
}
PATCH /contacts/{cname}
Modifica los datos de un contacto existente. No se puede usar en los registros en los que los contactos no son editables (p. ej. Ascio).
Parámetros:
cname– obligatorio, path – handle del contactotld– obligatorio, string – TLDauth_info– opcional, string – el código de autorización del contactocontact– obligatorio, object – datos del contacto que se van a modificar (los mismos campos que en POST /contacts/create; solo se cambian los campos indicados)reg_key– opcional, string – identificador de un registro concreto
Códigos de retorno:
1000– OK2100– falta un parámetro obligatorio2101– parámetros de entrada no válidos2201– TLD no válido2207– error de sintaxis2216– nombre de contacto no válido2219–2241– faltan elementos modificados concretos o su formato no es válido (el mismo conjunto que en la creación del contacto)3211– no se ha podido cargar el contacto3238– error de autorización3239– la modificación ha fallado4202– contacto no disponible – error de conexión4215– la ejecución ha fallado – 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/contacts/CONTACT' \
--data '{"tld": "eu", "contact": {"email": "esmeralda-new@wedos.com"}}'
{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3f6"
}
Notas
- Los endpoints bajo
/v2/domains,/v2/contactsy/v2/nssetslos 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. - En los contactos,
tldes siempre un parámetro obligatorio, porque el mismo handle (cname) puede existir en teoría en varios registros y la validación/el formato de los datos difieren según el TLD/registro.
