API REST es la interfaz a través de la cual puede controlar todos los servicios que ha adquirido con nosotros.
Cada solicitud de API debe autorizarse mediante el encabezado HTTP con el valor Bearer TOKEN.
Para administrar los Token acceda a la edición de la cuenta de usuario en el Área de Cliente.
- Cómo activar la interfaz API REST
- Administración de Tokens
- Entorno de desarrollo - sandbox
- Entorno de producción y documentación.
Cómo activar la interfaz API REST
La activación de la API no está vinculada a ninguna cuenta con permisos especiales. Simplemente cree y active lo que se denomina token en su cuenta de cliente, o también puede crear una nueva cuenta.
Puede crear un nuevo token en el Área de Cliente en la sección de Edición de datos del Cliente. Encontrará el acceso a la gestión de API en la parte inferior de la página.
Es posible crear varios tokens, que se utilizarán para autorizar solicitudes REST.
Instrucciones detalladas:
- Con sus datos de acceso, inicie sesión en el Área de cliente. Si no dispone de sus datos de acceso puede solicitar una nueva contraseña.
- En la esquina superior derecha, haga clic en el nombre de la empresa / nombre de usuario. Como alternativa, utilice el enlace a la administración de API y vaya al paso 4.
- Vaya a la parte inferior de la página y haga clic en API. Ahora podrá acceder a la administración de API.
- Haga clic en "Crear nuevo token".
- En el campo opcional "comentarios" puede escribir una descripción que le ayude a identificar los diferentes tokens creados.
- Establezca una fecha de caducidad, o deje el campo en blanco para una duración indefinida.
- En la restricción de acceso puede especificar la dirección IP del dispositivo habilitado para el funcionamiento del token. Si un dispositivo con otra dirección IP quiere utilizar un token, no se cumplirán los requisitos, y no se autorizará la solicitud.
- Tan pronto como haya completado todo lo que necesita, puede Añadir un nuevo token. Para ello, es necesario confirmar la contraseña de su cuenta de cliente.
Administración de Tokens
La administración de todos los tokens creados la puede realizar en el Área de Cliente.
Para ello debe acceder a la sección Editar los datos de su cuenta de cliente , al final de la página en el apartado API. Por razones de seguridad, será necesario introducir nuevamente la contraseña de la cuenta de cliente.
Después de hacer clic en Detalle, encontrará las opciones para editar la descripción del token o establecer sus limitaciones, ya sea la fecha de caducidad o permitir el acceso desde una dirección IP específica.
La restricción de la dirección IP solo funciona para una dirección IP o máscara en la notación CIDR. Si necesita limitar el acceso desde varias direcciones, debe configurar un nuevo token para cada IP.
Los tokens creados se pueden desactivar en cualquier momento. La desactivación del token puede tardar hasta 10 minutos en ser efectiva.
Los tokens desactivados no se pueden eliminar completamente, quedarán registrados en la cuenta para que el usuario siempre pueda averiguar qué tokens fueron utilizados en el pasado.
Entorno de desarrollo - sandbox
Cada solicitud enviada a través de la API debe autorizarse mediante el encabezado HTTP HTAR Bearer TOKEN.
Antes de crear su propio token, solo puede usar el entorno de pruebas en el servidor a través de la URL segura https://sandboxapi.active24.com. Un token válido para este entorno sandbox es 123456qwerty-ok.
Las solicitudes en el entorno sandbox no realizan ningún cambio en el sistema o el servicio, se utilizan únicamente para comprobar la validez de las solicitudes.
La documentación para el entorno del desarrollador está disponible en https://sandboxapi.active24.com.
Entorno de producción y documentación.
El entorno de producción de la API REST se ejecuta en el servidor solo a través del puerto protegido https://api.active24.com.
Para las especificaciones de todos los métodos disponibles en la API, consulte la documentación en https://api.active24.com.