Ry.hk Ry.hk

API

Administre dominios desde un programa en lugar de una página a la vez.

Registro de transferencias, verificación de disponibilidad, DNS y gestión en sus propios sistemas: pedidos al por mayor, barridos de renovación, un panel de control para sus clientes.

El API es la puerta de entrada de la máquina a las mismas operaciones que ofrece el área de clientes. Lo que puedes hacer en una página, puedes escribirlo.

DESCANSO HTTPS con respuestas JSON
Claves API Creado y revocado en el área de clientes
Cobertura total Mismas operaciones que el área de clientes.
Auditable Las llamadas se registran en la cuenta.

que es

  • Los puntos finales se agrupan por recurso (disponibilidad, dominios, servidores de nombres, contactos, pedidos y facturas) y devuelven JSON.
  • La autenticación utiliza una clave API generada en el área del cliente, que puede ser revocada y reemplazada en cualquier momento.
  • Usos típicos: registro masivo, barridos de vencimiento, sincronización del estado del dominio en su propio sistema, un panel de autoservicio para clientes y flujos de trabajo de certificados automatizados.
  • Se aplican las mismas reglas comerciales que en la web: un dominio no se puede registrar de la nada y una transferencia aún necesita un dominio desbloqueado y 60 días.

como funciona

01

Crear una clave

Genere una clave API en el área del cliente, con el alcance de lo que necesita hacer.

02

Leer la documentación

Puntos finales, parámetros y formas de respuesta.

03

Prueba pequeña

Pruebe puntos finales de solo lectura, o un par de dominios, antes de automatizar.

04

Iniciar sesión con el registro

Agregue reintentos y registros antes de que llegue a producción.

Disponibilidad y búsqueda

Verifique muchos nombres a la vez para monitorear y seleccionar.

Registro y renovación

Ordene, renueve y lea el estado del pedido.

DNS y servidores de nombres

Empuje registros y cambios de servidores de nombres de forma masiva.

Gestión de contactos

Lea y actualice el registrante, el administrador, el técnico y la facturación.

Pedidos y facturas

Leer pedidos, facturas y estado de pago.

Rotación de claves

Revocar y reemplazar claves; mantenga cada sistema en su propia clave.

Qué cubre el API

Por recurso

Recursoque puedes hacer
DominiosConsultar disponibilidad, registrarse, renovar, leer estado y caducidad
DNSLeer y configurar servidores de nombres, mantener registros DNS
Privacidad y contactosEstablezca el nivel de privacidad, actualice los cuatro roles de contacto
Pedidos y facturaciónLeer pedidos, facturas y estado de pago.
cuentaLeer el saldo y los detalles básicos de la cuenta.

Qué tener preparado antes de conectarse

Cuatro pequeñas cosas que ahorran la mayor parte de la depuración

  • Saldo o método de pago que funcione: el registro y la renovación son pedidos reales y una llamada fallará en el paso del pedido sin fondos.
  • Reintentos y manejo de errores: ocurren fallas en la red, límites de velocidad y retrasos en el flujo ascendente. Reintentar lecturas idempotentes; para pedidos, envíe una referencia única y verifique antes de escribir nuevamente.
  • Registro: registra la referencia, el dominio y el código de respuesta. Cuando algo se disputa más tarde, esos registros son la única prueba de que ocurrió la acción.
  • Mínimo privilegio: no utilice una clave grabable para un trabajo de solo lectura y proporcione a cada sistema su propia clave para que una pueda revocarse sin dañar las demás.

Una clave API equivale a una contraseña de cuenta. Guárdelo en una variable de entorno del lado del servidor o en un administrador de secretos, nunca en el código de interfaz de usuario y nunca en un repositorio.

Cómo lo usa la gente

Patrones comunes

  • Registrador masivo: envíe una selección para el registro y escriba los resultados en su propio backend.
  • Barridos de renovación: extrae dominios que se acercan a su vencimiento todas las noches y genera tus propios recordatorios o tareas de renovación.
  • Paneles de marca blanca: permita que sus clientes administren dominios dentro de su producto, sin iniciar sesión aquí.
  • Conciliación: extraiga datos de dominio y pedidos según un cronograma y cotejelos con su propio libro mayor.

Qué incluye cada pedido

API gestión de claves

Crear, revocar y separar claves por finalidad.

Documentación

Puntos finales, parámetros y respuestas.

Puntos finales de dominio y DNS

Buscar, registrar, renovar, DNS y servidores de nombres.

Puntos finales de pedidos y facturación

Pedidos, facturas y estado de pago.

Historial de llamadas

Registrado en la cuenta para solucionar problemas.

Soporte

Abra un ticket si una integración no funciona correctamente.

Preguntas comunes

¿Hay un cargo adicional por el API?

El API en sí no se cobra por separado; usted paga por las operaciones comerciales que realiza. Existe un límite de tarifa razonable para evitar un uso accidental o abusivo.

¿Existe un SDK?

API es HTTPS y JSON estándar, por lo que cualquier cliente HTTP funciona. La documentación incluye ejemplos de solicitudes que se pueden adaptar directamente.

¿Qué pasa si se pierde una clave?

Revocarlo en el área de clientes y generar uno nuevo. La revocación entra en vigor inmediatamente y las solicitudes que utilizan la clave anterior se rechazan.

¿Las pruebas cuestan algo?

Las llamadas de sólo lectura no cuestan nada. El registro y la renovación son pedidos reales y cuestan dinero, así que primero valide la lógica en una pequeña cantidad de dominios.

¿Puede el API administrar dominios registrados en otro lugar?

No. Opera en los dominios de esta cuenta, exactamente como lo hace el área de clientes.

Por favor tenga en cuenta

  • Mantenga las claves API en el servidor. Una clave enviada en el código del navegador o en un paquete móvil es una clave publicada.
  • Para solicitar puntos finales, envíe una referencia de solicitud única y verifique antes de escribir, para que un reintento de red no se registre ni se cobre dos veces.

¿Listo para empezar?

Abra la página de este servicio y finalice en unos pocos pasos. Si prefiere preguntar primero, un ticket le llegará a una persona.