La API de Blue utiliza un sistema de autenticación basado en tokens.
Encabezados
Antes de ejecutar cualquier consulta, es esencial configurar los encabezados para tu solicitud API. Estos encabezados permanecen consistentes en todas las solicitudes, requiriendo solo una configuración única. Sirven para autenticar cada solicitud a la API.
Los encabezados requeridos son el Token-ID y el Secret-ID, representados como x-bloo-token-id y x-bloo-token-secret respectivamente.
Además, ciertas solicitudes pueden requerir la inclusión de un Company-ID x-bloo-company-id y un Project-ID x-bloo-project-id para operaciones más específicas.
Puedes aprender a crear un token y un secreto en el siguiente video:
Token ID
El Token ID es tu identificador único para el acceso a la API.
Para comenzar a usar nuestra API, haz clic en tu perfil en la parte superior derecha, y en el menú de perfil, encontrarás la pestaña API.
En la pestaña API, haz clic en el botón "Generar un Token":
Proporciona un nombre para el token y establece una fecha de expiración si lo deseas. Si estableces una fecha de expiración, el token de API dejará de funcionar automáticamente después de esa fecha.
Después de la generación, se te mostrará un Token ID y un Secret ID. El Token ID estará precedido por pat_ para fácil identificación.
Secret ID
El Secret ID actúa como una contraseña, asegurando una comunicación segura con la API de Blue.
Recuerda, el Secret ID se muestra solo una vez por razones de seguridad, así que guárdalo de forma segura para mantener el acceso a tus datos a través de la API. Para máxima seguridad, Blue almacena tu secreto utilizando hash bcrypt, lo que significa que incluso nuestro equipo no puede recuperar tu secreto en texto plano después de su creación.
Asegúrate de mantener seguro tu Token ID y Secret ID, ya que cualquier persona con acceso a estas credenciales puede acceder a tus datos en Blue.
Company & Project IDs
Aquí hay un video que muestra cómo encontrar tu company ID y project ID en Blue:
Las empresas son la entidad de nivel superior en Blue. Los Company IDs se utilizan para identificar una empresa en Blue. Se utilizan en la API para especificar con qué empresa interactuar. El ID es el mismo que el slug de la empresa en la URL cuando visitas la empresa en Blue:
app.blue.cc/company/{company-id}/
Para ciertas consultas y mutaciones, necesitarás proporcionar un Project ID. Este es el ID del proyecto con el que deseas interactuar. El ID es el mismo que el slug del proyecto en la URL cuando visitas el proyecto en Blue:
app.blue.cc/company/{company-id}/project/{project-id}/