API's Command Center 

Autenticación

Cada solicitud API enviada desde una aplicación de terceros al sitio web del Command Center será autenticada y autorizada como si un usuario real estuviera usando el software. Los permisos de grupo del usuario asociado con la solicitud de la API determinarán qué campos se puede ver y/o editar para cada solicitud de la API.

Para usar la API, cada usuario debe tener una o más claves API secretas que identifiquen a ese usuario en la API. La clave secreta API es un número de 160 bits expresado en forma hexadecimal. Esta es una cantidad astronómicamente grande de claves únicas, lo que significa que adivinar una clave API es casi imposible.

Para generar una clave API para un usuario determinado, los usuarios deben iniciar sesión y hacer clic en su nombre en la esquina superior derecha de cualquier página para acceder al menú contextual del usuario. Habrá una opción de "teclas de API" en ese menú para ir a la página.

Si se utiliza una clave API desconocida repetidamente, la API deshabilitará el acceso por un período de tiempo. Los usuarios aún podrán iniciar sesión en el sitio web de Command Center durante este tiempo. Cuando la API está desactivada, enviará una respuesta Prohibida HTTP 403 a cualquier solicitud que reciba.

En el nivel HTTP, la clave API se envía a través de autenticación básica HTTP. Use la clave secreta como el nombre de usuario y cualquier cadena aleatoria para la contraseña.

Para obtener más información acerca de la Autenticación básica HTTP, consulte este útil artículo de wikipedia.

Realizar Solicitudes

• All requests should be in UTF-8.
• Todas las solicitudes realizadas a nuestras API's deben enviarse a través de HTTPS. El certificado SSL utilizado para la conexión HTTPS está firmado y todas las implementaciones deben configurar su capa SSL para verificarlo.
• Las solicitudes se realizan a una URL que comienza con: https://api.baseline.info/
• Las solicitudes API pueden ser aceleradas si Baseline considera que son demasiado frecuentes. Las implementaciones siempre deben estar listas para una respuesta de Servicio 503 no disponible.
• Las implementaciones también deberían estar siempre listas para la pérdida general de paquetes de Internet, lo que da como resultado conexiones rotas sin respuesta HTTP.
• Cada empleado tiene una identificación de empleado inmutable que es única dentro de una sola compañía que puede usar para hacer referencia al empleado.
• Todas las solicitudes deben estar en UTF-8.

Códigos de Estado HTTP

Cada solicitud incluye un código de estado HTTP con el resultado. El código de estado debe examinarse antes de la respuesta.

Códigos de estado exitosos (2xx)

• 200 OK - La solicitud fue exitosa.
• 201 Creado - El recurso fue creado con éxito. Confirma un éxito al crear un nuevo empleado, solicitud de tiempo de inactividad, etc.

Códigos de estado de error del cliente (4xx)

• 400 Solicitud incorrecta: la solicitud no fue válida o el servidor no la entendió. Volver a enviar la solicitud probablemente genere el mismo error.
• 401 no autorizado: falta su clave de API.
• 403 Prohibido: la aplicación está intentando realizar una acción para la que no tiene privilegios de acceso. Verifique que su clave API pertenece a un usuario habilitado con los permisos necesarios.
• 404 No encontrado: el recurso no se encontró con el identificador proporcionado. O la URL dada no es una API válida, o la ID del objeto especificado en la solicitud no es válida.
• 406 No aceptable: la solicitud contiene referencias a campos inexistentes.
• 409 Conflicto: la solicitud intenta crear un duplicado. Para los empleados, no se permiten correos electrónicos duplicados. Para las listas, los valores duplicados no están permitidos.
• 429 Límite excedido: la cuenta ha alcanzado su límite de empleados. No se pueden agregar empleados adicionales.

Códigos de estado de error del servidor (5xx)

• 500 Error interno del servidor: el servidor detectó un error al procesar su solicitud y falló.
• 502 Error de puerta de enlace: el equilibrador de carga o el servidor web tuvieron problemas para conectarse a la aplicación Command Center. Por favor, intente de nuevo la petición.
• 503 Servicio no disponible: el servicio no está disponible temporalmente. Por favor, intente de nuevo la petición.

Puede probar su código en el futuro utilizando los siguientes rangos:

• 200-299 como éxito
• 400-499 como errores de solicitud del cliente
• 500-599 como errores del servidor

System Users & Passport Users

Compatibility Between Versions

Every attempt will be made to make only forward compatible changes to the API. To assist this effort, API consumers should ignore any XML tags and attributes they do not recognize.

The API will support multiple major version numbers of the API. Currently the only version is "v1". If a major API change becomes necessary, we’ll create a new major version number and communicate the change to our partners. We’ll maintain the existing "v1" API for a reasonable period of time.