Guía API para Desarrolladores
Guía API para Desarrolladores
Puedes autenticar la API de Ragic al proveer una de tus claves API en la solicitud. Tus claves API tienen muchos privilegios, ¡asegúrate de mantenerlas en secreto!
Cuando tu código accede a la API de Ragic vía una clave API, básicamente inicia sesión como el usuario de la clave API y ejecuta lectura y escritura como este usuario. Te recomendamos crear un usuario distinto para este acceso con clave API. De esta manera el acceso API no se mezclará con un usuario organizacional, lo cual hace que el registro de auditoría del sistema sea más claro y la depuración (debugging) de tu API sea más fácil.
La autenticación de API se realiza vía autenticación básica HTTP. Provee tu clave API como el usuario básico de autenticación. No necesitas brindar una contraseña.
Todas las solicitudes API deben ser realizadas a través de HTTPS. Las llamadas realizadas sobre HTTP fallarán. Debes autenticar para todas las solicitudes.
curl https://www.ragic.com/demo/sales/1\ --get -d api \ -H "Authorization:Basic TU_CLAVE_API_VA_AQUÍ"
Nótese que el nombre del encabezado del HTTP es Authorization, y el valor es tu clave API precedida de “Basic ”, Basic con un espacio al final y quizá necesites modificar www a na3, ap5, ó eu2 en tu URL según tu URL de cuenta Ragic.
Puedes encontrar la clave API del usuario en el menú cambiar contraseña en tu cuenta Ragic. Sólo desplázate sobre tu nombre de usuario en la parte superior derecha de tu cuenta Ragic y encontrarás el enlace para cambiar contraseña.
Puedes hacer clic aquí para obtener la clave API para el usuario con el que has iniciado sesión en Ragic. Si estás en un servidor on-premise, puedes iniciar sesión primero y usar el siguiente URL para obtener tu clave API: http://
La mayoría de los clientes HTTP (incluyendo exploradores web) muestran un cuadro de diálogo o te indican que debes proveer un nombre de usuario y contraseña (vacía) para autenticación básica HTTP. La mayoría de las clientes te permitirán dar tus credenciales directamente en el URL.
Si por alguna razón no puedes enviar la clave API como el encabezado de HTTP o autorización básica, puedes enviar la clave API como un parámetro con el nombre APIKey. Necesitarás agregar este parámetro para cada solicitud individual que envíes.
curl https://www.ragic.com/demo/sales/1\ --get -d api \ -d "APIKey=YOUR_API_KEY_GOES_HERE"
