Descripción general de la API REST de administración
¿Qué es la API REST de administración?
La API REST de administración le permite gestionar su cuenta de MTCaptcha desde su propio código, en lugar de usar la consola de administración. Está pensada para desarrolladores que quieren automatizar la configuración de sitios, por ejemplo al incorporar muchos sitios web.
Con ella puede:
- Sitios: listar sus sitios y actualizar el nombre y la configuración de un sitio.
- Dominios: ver, añadir y eliminar los dominios de producción y de desarrollo de un sitio.
- Lista blanca de IP: ver, añadir y eliminar las direcciones IP de la lista blanca de un sitio.
La API funciona únicamente con su propia cuenta. Los límites de su plan se aplican exactamente igual que en la consola de administración.
La API REST de administración es distinta de la API CheckToken, que se usa para validar un token verificado. La API REST de administración gestiona su cuenta. La API CheckToken verifica el resultado de un captcha en su servidor.
Antes de empezar
- Solicite acceso. La API REST de administración no está activada de forma predeterminada. Póngase en contacto con support@mtcaptcha.com para activarla en su cuenta.
- Genere su clave de API. Una vez activada, el Super Admin de su cuenta puede abrir Admin API en el menú izquierdo de la consola de administración y generar allí la clave.
Trate la clave de API como una contraseña. Úsela solo desde su servidor, nunca en código de navegador, aplicaciones móviles ni repositorios públicos. Si cree que puede haberse expuesto, regenérela desde la página Admin API. La clave anterior y los tokens emitidos con ella dejan de funcionar de inmediato.
Qué puede hacer
Resumen de las llamadas disponibles. Todas las rutas comienzan con /v1.
Sitios
| Método | Ruta | Descripción |
|---|---|---|
GET | /sites | Lista sus sitios. Filtros opcionales: from, to, sortField, sortOrder. |
PATCH | /sites/{sitePublicId} | Actualiza el nombre y la configuración de un sitio. |
Dominios
| Método | Ruta | Descripción |
|---|---|---|
GET | /sites/{sitePublicId}/domains | Lista todos los dominios. Añada /prod o /dev para filtrar. |
POST | /sites/{sitePublicId}/domains/{type} | Añade un dominio. type es prod o dev. |
DELETE | /sites/{sitePublicId}/domains/{type}/{domainName} | Elimina un dominio. |
Lista blanca de IP
| Método | Ruta | Descripción |
|---|---|---|
GET | /sites/{sitePublicId}/ip-whitelist | Lista las direcciones IP de la lista blanca. |
POST | /sites/{sitePublicId}/ip-whitelist | Añade una dirección IP. |
DELETE | /sites/{sitePublicId}/ip-whitelist?ipAddress=... | Elimina una dirección IP. |
Primeros pasos
La autenticación consta de dos pasos. Intercambia su clave de API por un token de acceso de corta duración y luego incluye ese token en cada solicitud. Sustituya YOUR_API_KEY y YOUR_TOKEN por sus propios valores y ejecute estos comandos desde su servidor o terminal, nunca desde una página web.
Paso 1: Obtener un token de acceso
curl -X POST "https://admin-api.mtcaptcha.com/auth/token" \
-H "X-Api-Key: YOUR_API_KEY"
Recibirá el token. Úselo en el siguiente paso:
{ "status": "success", "token": "..." }
Paso 2: Listar sus sitios
curl "https://admin-api.mtcaptcha.com/v1/sites" \
-H "Authorization: Bearer YOUR_TOKEN"
Paso 3: Continuar y renovar cuando sea necesario
Incluya el mismo encabezado Authorization: Bearer YOUR_TOKEN en cada solicitud. Los tokens son de corta duración: cuando reciba una respuesta 401, repita el Paso 1 para obtener un token nuevo. No solicite un token nuevo en cada llamada.
Los errores se devuelven como JSON con un status y un message que explica qué debe corregirse.
Referencia de la API
La lista completa de endpoints, los formatos de solicitud y respuesta, y la posibilidad de probar cada llamada están disponibles en la referencia de Swagger:
Abrir la referencia de la API REST de administración (Swagger)
¿No encontraste lo que necesitabas? No dudes en ponerte en contacto con nuestro equipo de soporte en support@mtcaptcha.com o mándanos un mensaje en nuestra página de contacto.