Saltearse al contenido

Claves API

Las Claves API se utilizan para autorizar el acceso a la API y deben incluirse con cada solicitud. Hay dos tipos de Claves API:

Claves API Gratuitas

Las Claves API Gratuitas se pueden crear sin costo alguno, proporcionando acceso limitado a la API.

Condiciones para utilizar Claves API Gratuitas:

Generación de una Clave API Gratuita

Las Claves API Gratuitas están vinculadas a un nombre de dominio específico y solo funcionan en sitios web hospedados en el nombre de dominio proporcionado.

Las Claves API Gratuitas requieren atribución en tu sitio web.

Generar una Clave API Gratuita
Si estás usando un número de puerto no estándar, ingresa el nombre de dominio y el puerto en este formato: ejemplo.com:3000.

El servidor generará una nueva Clave API Gratuita y un secreto:

{
"hostname": "ejemplo.com",
"apiKey": "ckey_49960de...",
"secret": "csec_55de16dde79f94...",
"license": "..."
}

El secreto csec_... se utiliza para la verificación de la carga útil (como secreto HMAC) y debe mantenerse confidencial, nunca expuesto públicamente.

Consulta la documentación para aprender cómo generar una nueva Clave API usando la API.

Verificación de Dominio

Aunque es opcional, se recomienda encarecidamente la verificación de dominio. Verificar la propiedad de su nombre de dominio a través del registro DNS TXT configurado con el valor proporcionado altcha-verification=... añade una capa adicional de seguridad.

La verificación de dominio asegura que su Clave de API esté asociada adecuadamente con el nombre de dominio con el que se pretende trabajar.

Para verificar su nombre de dominio, siga estos pasos:

  1. Acceda a su panel de gestión de registros DNS.
  2. Agregue un registro TXT con los siguientes detalles:
    • Tipo de Registro: TXT
    • Host/Nombre: @ (o su nombre de dominio)
    • Valor/Texto: altcha-verification=abc... (sustituya abc... por su token de verificación único obtenido al generar la Clave de API)
  3. Guarde los cambios.

Una vez que se haya agregado y propagado correctamente el registro DNS, se verificará la propiedad del dominio. Esto asegura el uso seguro de su Clave de API con el nombre de dominio especificado.

Atribución para Claves API Gratuitas

Al utilizar la Clave API Gratuita, DEBES mostrar “Protegido por ALTCHA” junto con el logotipo en el widget (es decir, no utilices hidelogo o hidefooter). Si no estás utilizando el widget, DEBES incluir una atribución en el pie de página de tu sitio web, al menos en la página de inicio:

<a href="https://altcha.org">Protegido por ALTCHA</a>

Puedes traducir o modificar el texto, pero debe transmitir un significado similar a “Protegido por ALTCHA”. El enlace debe dirigirse a https://altcha.org y no debe incluir rel="nofollow".

Claves de API de Pago

Los planes de pago para la API están disponibles en la aplicación Forms. Todos los planes SaaS otorgan acceso tanto a la API del Filtro de Spam como a los Formularios. Alternativamente, puede optar por planes Solo AntiSpam, que ofrecen acceso a la API sin Formularios.

Para obtener acceso a la API de pago, siga estos pasos:

  1. Regístrese para obtener una nueva cuenta en ALTCHA Forms en eu.altcha.org para clientes de la UE o us.altcha.org para clientes de EE. UU.
  2. Dentro de la aplicación, vaya a Configuración de cuenta -> Facturación y seleccione el plan deseado.
  3. Complete el proceso de compra.
  4. Genere una nueva clave de API dentro de Configuración de cuenta -> Claves de API.