API Blue использует систему аутентификации на основе токенов.
Заголовки
Перед выполнением любых запросов важно настроить заголовки для вашего API-запроса. Эти заголовки остаются неизменными для всех запросов, требуя лишь одноразовой настройки. Они служат для аутентификации каждого запроса к API.
Обязательные заголовки — это Token-ID и Secret-ID, представленные как x-bloo-token-id и x-bloo-token-secret соответственно.
Кроме того, некоторые запросы могут потребовать включения Company-ID x-bloo-company-id и Project-ID x-bloo-project-id для более специфичных операций.
Вы можете узнать, как создать токен и секрет в следующем видео:
Token ID
Token ID — это ваш уникальный идентификатор для доступа к API.
Чтобы начать использовать наш API, нажмите на свой профиль в правом верхнем углу, и в меню профиля вы найдете вкладку API.
На вкладке API нажмите кнопку "Сгенерировать токен":
Укажите имя для токена и установите дату истечения, если это необходимо. Если вы установите дату истечения, токен API автоматически перестанет работать после этой даты.
После генерации вам будет показан Token ID и Secret ID. Token ID будет иметь префикс pat_ для удобства идентификации.
Secret ID
Secret ID действует как пароль, обеспечивая безопасное взаимодействие с API Blue.
Помните, что Secret ID показывается только один раз по соображениям безопасности, поэтому храните его в безопасном месте, чтобы сохранить доступ к вашим данным через API. Для максимальной безопасности Blue хранит ваш секрет с использованием хеширования bcrypt, что означает, что даже наша команда не может восстановить ваш открытый секрет после его создания.
Убедитесь, что вы храните свой Token ID и Secret ID в безопасности, так как любой, кто имеет доступ к этим учетным данным, может получить доступ к вашим данным в Blue.
Company & Project IDs
Вот видео, которое показывает, как найти ваш Company ID и Project ID в Blue:
Компании являются верхнеуровневой сущностью в Blue. Company IDs используются для идентификации компании в Blue. Они используются в API для указания, с какой компанией взаимодействовать. ID совпадает с слагом компании в URL, когда вы посещаете компанию в Blue:
app.blue.cc/company/{company-id}/
Для определенных запросов и мутаций вам потребуется предоставить Project ID. Это ID проекта, с которым вы хотите взаимодействовать. ID совпадает с слагом проекта в URL, когда вы посещаете проект в Blue:
app.blue.cc/company/{company-id}/project/{project-id}/