Skip to content

feat: send X-Axme-Client header for AXME analytics #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
George-iam merged 1 commit into from
Apr 10, 2026
Merged

feat: send X-Axme-Client header for AXME analytics #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/main/java/dev/axme/sdk/AxmeClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@
import java.util.UUID;

public final class AxmeClient {

/**
* Published axme-sdk-java version. Sent in X-Axme-Client header so AXME
* platform analytics can identify SDK usage. Bump on every release.
*/
public static final String SDK_VERSION = "0.2.0";

private final String baseUrl;
private final String apiKey;
private final String actorToken;
Expand Down Expand Up @@ -864,6 +871,7 @@ Map<String, Object> requestJson(
.header("Accept", "application/json");

builder.header("x-api-key", apiKey);
builder.header("X-Axme-Client", "axme-sdk-java/" + SDK_VERSION);
String resolvedAuthorization = options.getAuthorization();
if (isBlank(resolvedAuthorization) && !isBlank(actorToken)) {
resolvedAuthorization = "Bearer " + actorToken;
Expand Down
9 changes: 9 additions & 0 deletions src/test/java/dev/axme/sdk/AxmeClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ void registerNickSendsPayloadAndHeaders() throws Exception {
assertEquals("POST", request.getMethod());
assertEquals("/v1/users/register-nick", request.getPath());
assertEquals("token", request.getHeader("x-api-key"));
assertEquals("axme-sdk-java/" + AxmeClient.SDK_VERSION, request.getHeader("X-Axme-Client"));
assertEquals("register-1", request.getHeader("Idempotency-Key"));

Map<String, Object> body =
Expand All @@ -54,6 +55,14 @@ void registerNickSendsPayloadAndHeaders() throws Exception {
assertTrue((Boolean) response.get("ok"));
}

@Test
void clientSendsXAxmeClientHeader() throws Exception {
server.enqueue(new MockResponse().setResponseCode(200).setBody("{\"ok\":true,\"available\":true}"));
client.checkNick("@partner.user", RequestOptions.none());
RecordedRequest request = server.takeRequest();
assertEquals("axme-sdk-java/" + AxmeClient.SDK_VERSION, request.getHeader("X-Axme-Client"));
}

@Test
void clientSendsConfiguredActorToken() throws Exception {
server.enqueue(new MockResponse().setResponseCode(200).setBody("{\"ok\":true,\"available\":true}"));
Expand Down
Loading