C++ APISession methods
link_license
Links a license to the current authorized account context.
link_license(std::string license) links a license to the currently
authorized account and returns blaze::status.
Function variants
blaze::status link_license(std::string license);
blaze::status link_license(std::string license, std::error_code& ec) noexcept;
void async_link_license(std::string license, std::function<void(std::error_code, blaze::status)> callback);
blaze::coro::awaitable_result<blaze::status> co_link_license(std::string license);Status vs error
The returned blaze::status is the API result. std::error_code and
std::system_error are used for transport/runtime failures only.
Parameters
Prop
Type
Result
blaze::statusUse direct comparison, for example:
if (status == blaze::status::ok) {
// success
}Behavior notes
- Call
link_licenseonly after successfulconnectandinitialize. link_licenserequires an already authorized account context fromauthorize(credentials).- License-only authorization is not enough for this operation.
- License length is validated locally before the request is sent. On local validation failure, transport error is empty and the returned
blaze::statuscontains the length status. - On success, the server links the license to the current account and activates it.
Example
Compilation note
Synchronous and Asynchronous examples compile in the same form from C++17
to C++26.
#include "blazeauth/api/api.hpp"
#include <iostream>
#include <string>
#include <system_error>
void print_error_code(const std::string& context, const std::error_code& ec) {
std::cout << context << ": " << ec.message() << " ("
<< ec.value() << " : " << ec.category().name() << ")\n";
}
std::string read_line(const std::string& label) {
std::string value;
std::cout << label << ": ";
std::getline(std::cin, value);
return value;
}
void print_status(const std::string& context, blaze::status status) {
std::cout << context << ": "
<< static_cast<unsigned int>(status)
<< " (" << blaze::to_string(status) << ")\n";
}
int main() {
const std::string websocket_api_key = read_line("Websocket API key");
const std::string client_id = read_line("Client ID");
const std::string login = read_line("Login");
const std::string password = read_line("Password");
const std::string license_to_link = read_line("License to link");
blaze::account_credentials credentials;
credentials.login = login;
credentials.password = password;
credentials.type = blaze::credentials_type::login_password;
blaze::session session;
try {
const blaze::api_server server = session.connect();
std::cout << "Connected to server location: " << server.location << '\n';
const blaze::application app = session.initialize(websocket_api_key, client_id);
if (!app.good()) {
print_status("Initialize returned status", app.status);
return 1;
}
const blaze::account account = session.authorize(credentials);
if (!account.good()) {
print_status("Authorize returned status", account.status);
return 1;
}
const blaze::status link_status = session.link_license(license_to_link);
if (link_status != blaze::status::ok) {
print_status("Link-license returned status", link_status);
return 1;
}
std::cout << "License linked successfully\n";
session.shutdown();
} catch (const std::system_error& e) {
print_error_code("Link-license failed", e.code());
return 1;
}
return 0;
}Link-license statuses
| Value | Status | Returned when |
|---|---|---|
1 | ok | License was linked successfully. |
3 | not_authorized | Session does not have an authorized account context. |
6 | internal_server_error | Server could not complete link-license because of an internal error. |
100 | license_not_found | License does not exist in the current application. |
101 | license_too_short | license is shorter than 6 characters. This is rejected locally before the request is sent. |
102 | license_too_long | license is longer than 64 characters. This is rejected locally before the request is sent. |
106 | license_already_linked | License is already linked to an account. |
107 | license_already_activated | License is already activated. |
Connection-level shutdowns
Normal link-license results are returned as
blaze::status. The websocket may still be closed by session-level guards:
| Close code | Meaning | When it can happen |
|---|---|---|
4200 | not_initialized | link_license was called before a successful initialize. |
4201 | rate_limited | Session or IP rate limiting closed the websocket around this operation. |