---

Cabeçalhos

Antes de executar qualquer consulta, é essencial configurar os cabeçalhos para sua solicitação de API. Esses cabeçalhos permanecem consistentes em todas as solicitações, exigindo apenas uma configuração única. Eles servem para autenticar cada solicitação à API.

Os cabeçalhos obrigatórios são o Token-ID e o Secret-ID, representados como x-bloo-token-id e x-bloo-token-secret, respectivamente.

Além disso, certas solicitações podem necessitar da inclusão de um Company-ID x-bloo-company-id e Project-ID x-bloo-project-id para operações mais específicas.

Você pode aprender como criar um token e um segredo no vídeo a seguir:

Token ID

O Token ID é seu identificador único para acesso à API.

Para começar a usar nossa API, clique no seu perfil no canto superior direito e, no menu do perfil, você encontrará a aba API.

Na aba API, clique no botão "Gerar um Token":

Forneça um nome para o token e defina uma data de expiração, se desejar. Se você definir uma data de expiração, o token da API deixará de funcionar automaticamente após essa data.

Após a geração, você verá um Token ID e um Secret ID. O Token ID será prefixado com pat_ para fácil identificação.

Secret ID

O Secret ID atua como uma senha, garantindo comunicação segura com a API da Blue.

Lembre-se, o Secret ID é exibido apenas uma vez por razões de segurança, portanto, armazene-o com segurança para manter o acesso aos seus dados através da API. Para máxima segurança, a Blue armazena seu segredo usando hashing bcrypt, o que significa que até nossa equipe não pode recuperar seu segredo em texto simples após a criação.

Company & Project IDs

Aqui está um vídeo que mostra como encontrar seu Company ID e Project ID na Blue:

As empresas são a entidade de nível superior na Blue. Os Company IDs são usados para identificar uma empresa na Blue. Eles são usados na API para especificar com qual empresa interagir. O ID é o mesmo que o slug da empresa na URL quando você visita a empresa na Blue:

app.blue.cc/company/{company-id}/

Para certas consultas e mutações, você precisará fornecer um Project ID. Este é o ID do projeto com o qual você deseja interagir. O ID é o mesmo que o slug do projeto na URL quando você visita o projeto na Blue:

app.blue.cc/company/{company-id}/project/{project-id}/