WEDOS REST API está todavía en desarrollo. El acceso y las funciones pueden cambiar sin previo aviso.
Este artículo describe parcialmente el endpoint WEDOS.protection de WEDOS REST API. Dominios de WEDOS.protection y servicios tienen sus propios artículos. Para WEDOS API (WAPI), consulte WAPI – WEDOS Protection.
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 WGP
WGP HTTP REST API v2 sirve para gestionar dominios, servicios e invitaciones de cogestión en WEDOS.protection (WGP).
URL base y autenticación
La URL base de los endpoints WGP es: https://api.wedos.com/v2
Para la autenticación se utiliza únicamente OAuth2: incluya un token de acceso válido en la cabecera de la solicitud (Authorization: Bearer <TOKEN>) con el scope wgp . Sin un token válido, la API devuelve el error 2000.
Puede añadir el parámetro example=1 a cualquier endpoint como parámetro GET (?example=1 en los endpoints sin parámetros GET propios; en caso contrario, &example=1). La API devuelve entonces un comando curl de ejemplo para esa llamada, sin necesidad de indicar parámetros reales. También en este modo se requiere una autenticación válida.
Resumen de endpoints
| Método | Endpoint | Descripción |
|---|---|---|
| POST | /members | Creación de una invitación de cogestión de dominios |
| GET | /members/{email} | Consulta de una invitación de cogestión |
| DELETE | /members/{email} | Eliminación de una invitación de cogestión |
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).
Códigos de retorno generales válidos para todos los endpoints (capa REST, con independencia de la operación concreta):
1000– operación correcta (OK)2000– autenticación (token Bearer de OAuth2) ausente o no válida2004– se ha superado el tamaño máximo de la solicitud (URL o cuerpo de la solicitud)4000– método de la API desconocido o no admitido (la combinación de método HTTP y ruta invocada no existe)4001– la validación de la entrada ha fallado4005– no hay ningún ejemplo disponible para el endpoint actual en el modoexample=1.6000– error interno al inicializar el comando WAPI subyacente
Además, cada endpoint devuelve sus propios códigos de negocio específicos de la operación (correspondientes al comando WAPI subyacente). Se indican en el apartado Códigos de retorno de cada endpoint.
POST /members
Crea una invitación para cogestionar uno o varios dominios WGP para la dirección de correo electrónico indicada.
Parámetros:
email– obligatorio – dirección de correo electrónico para la que se crea la invitaciónpolicies– obligatorio, objeto – un array asociativo con la forma{domain or "*" (all domains) => 0/1}, p. ej.{"domain1.tld":1}o{"*":1}; no es un simple array de nombres de dominio
Códigos de retorno:
1000– OK2223– formato no válido o dirección de correo electrónico inexistente2419– invitación no encontrada2420– array de reglas o condiciones de dominio no válido (policies)2424– la pertenencia ya existe2400– error interno – código de retorno no registrado
Datos de la respuesta:
email– dirección de correo electrónico de la invitaciónurl– URL para confirmar la invitaciónpolicies_count– número de reglas indicadas
Ejemplo:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/wgp/members' \
--data '{"email":"esmeralda@wedos.com","policies":{"domain1.tld":1}}'{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3d4",
"data": {
"email": "esmeralda@wedos.com",
"url": "https://wgp.wedos.com/invite/abc123def456",
"policies_count": 1
}
}GET /members/{email}
Muestra una invitación de cogestión de dominios existente para la dirección de correo electrónico indicada.
Parámetros:
email– obligatorio, path, codificado en URL (p. ej.%40para@) – dirección de correo electrónico de la invitación
Códigos de retorno:
1000– OK2223– formato no válido o dirección de correo electrónico inexistente2419– invitación no encontrada2400– error interno – código de retorno no registrado
Datos de la respuesta:
email– dirección de correo electrónico de la invitaciónurl– URL para confirmar la invitaciónpolicies_count– número de reglas indicadas
Ejemplo:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/wgp/members/esmeralda%40wedos.com'{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3d4",
"data": {
"email": "esmeralda@wedos.com",
"url": "https://wgp.wedos.com/invite/abc123def456",
"policies_count": 1
}
}DELETE /members/{email}
Elimina una invitación de cogestión de dominios existente para la dirección de correo electrónico indicada.
Parámetros:
email– obligatorio, path, codificado en URL – dirección de correo electrónico de la invitación
Códigos de retorno:
1000– OK2223– formato no válido o dirección de correo electrónico inexistente2419– invitación no encontrada2400– error interno – código de retorno no registrado
Datos de la respuesta:
email– dirección de correo electrónico de la invitación eliminada
Ejemplo:
curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/wgp/members/esmeralda%40wedos.com'{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3d4",
"data": {
"email": "esmeralda%40wedos.com"
}
}Notas
- Ni POST /members ni GET /members/{email} devuelven nunca en su respuesta el contenido de las policies indicadas, solo email, url y policies_count. Se trata del comportamiento de la administración externa de WGP, no de una limitación de esta capa REST.