update env var name (#26)

* update env var name

* update changelog

* update api_url to api_base_url

Author: martinatpeek

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [2025-10-15]
 
 ### Changed
+- **BREAKING**: Configuration key `peek_app_key` has been renamed to `peek_api_key`
 - **BREAKING**: Configuration key `peek_api_url` has been deprecated in favor of `peek_api_base_url`
   - The new `peek_api_base_url` should contain only the base URL (e.g., `"https://apps.peekapis.com"`)
   - The SDK automatically appends appropriate paths (e.g., `/backoffice-gql`) for different API endpoints

README.md

@@ -11,8 +11,8 @@ writing apps.
 config :peek_app_sdk,
   peek_app_secret: "APP_SECRET",
   peek_app_id: "APP_ID",
-  peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-  peek_app_key: "APP_KEY"
+  peek_api_base_url: "https://apps.peekapis.com/",
+  peek_api_key: "API_KEY"
 ```
 
 ### Multiple Application Configurations
@@ -24,8 +24,8 @@ PeekAppSDK supports multiple configurations, allowing different applications to
 config :peek_app_sdk,
   peek_app_secret: "DEFAULT_SECRET",
   peek_app_id: "DEFAULT_APP_ID",
-  peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-  peek_app_key: "DEFAULT_APP_KEY",
+  peek_api_base_url: "https://apps.peekapis.com/",
+  peek_api_key: "DEFAULT_API_KEY",
   # Centralized app configurations
   apps: [
     project_name: [peek_app_id: "project_name_APP_ID", peek_app_secret: "project_name_APP_SECRET"],
@@ -43,7 +43,7 @@ PeekAppSDK.query_peek_pro("install_id", "query { test }")
 PeekAppSDK.query_peek_pro("install_id", "query { test }", %{}, :project_name)
 ```
 
-Note that `peek_api_url` and `peek_app_key` are always taken from the default configuration.
+Note that `peek_api_base_url` and `peek_api_key` are always taken from the default configuration.
 
 ## Some setup tips:
 

config/test.exs

@@ -5,13 +5,13 @@ config :peek_app_sdk,
   peek_app_secret: "test_secret",
   peek_app_id: "test_app_id",
   peek_api_base_url: "https://apps.peekapis.com",
-  peek_app_key: "test_app_key",
+  peek_api_key: "test_api_key",
   client_secret_token: "test_client_secret",
   # Centralized configuration structure
   apps: [
     project_name: [
       peek_app_id: "project_name_app_id",
-      peek_app_key: "project_name_app_key",
+      peek_api_key: "project_name_api_key",
       peek_app_secret: "project_name_app_secret",
       client_secret_token: "project_name_client_secret"
     ],

lib/peek_app_sdk.ex

@@ -24,16 +24,16 @@ defmodule PeekAppSDK do
   config :peek_app_sdk,
     peek_app_secret: "DEFAULT_SECRET",
     peek_app_id: "DEFAULT_APP_ID",
-    peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-    peek_app_key: "APP_KEY",
+    peek_api_base_url: "https://apps.peekapis.com/",
+    peek_api_key: "API_KEY",
     # Centralized app configurations
     apps: [
       project_name: [peek_app_id: "project_name_APP_ID", peek_app_secret: "project_name_APP_SECRET"],
       another_app: [peek_app_id: "ANOTHER_APP_ID", peek_app_secret: "ANOTHER_APP_SECRET"]
     ]
   ```
 
-  Note that `peek_api_base_url` and `peek_app_key` are always taken from the default
+  Note that `peek_api_base_url` and `peek_api_key` are always taken from the default
   `:peek_app_sdk` configuration, regardless of which application identifier is used.
   """
 
@@ -50,7 +50,7 @@ defmodule PeekAppSDK do
         peek_app_secret: "project_name_secret",
         peek_app_id: "project_name_app_id",
         peek_api_base_url: "https://apps.peekapis.com",
-        peek_app_key: "default_app_key"
+        peek_api_key: "default_api_key"
       }
 
   Using the default configuration:
@@ -60,7 +60,7 @@ defmodule PeekAppSDK do
         peek_app_secret: "default_secret",
         peek_app_id: "default_app_id",
         peek_api_base_url: "https://apps.peekapis.com",
-        peek_app_key: "default_app_key"
+        peek_api_key: "default_api_key"
       }
   """
   @spec get_config(atom() | nil) :: map()

lib/peek_app_sdk/client.ex

@@ -39,7 +39,7 @@ defmodule PeekAppSDK.Client do
 
     config = Config.get_config(config_id)
     peek_app_id = config.peek_app_id
-    peek_app_key = config.peek_app_key
+    peek_api_key = config.peek_api_key
 
     operation_name = operation_name(gql_query)
 
@@ -49,7 +49,7 @@ defmodule PeekAppSDK.Client do
            method: :post,
            url: url,
            body: body_params,
-           headers: headers(install_id, config_id, peek_app_key)
+           headers: headers(install_id, config_id, peek_api_key)
          ) do
       # If we get back an error, fail the whole thing and return the error for now.
       {:ok, %Tesla.Env{status: 200, body: %{errors: [_error | _rest] = errors}}} ->
@@ -98,10 +98,10 @@ defmodule PeekAppSDK.Client do
     [x_peek_auth_header(install_id, config_id)]
   end
 
-  defp headers(install_id, config_id, peek_app_key) do
+  defp headers(install_id, config_id, peek_api_key) do
     [
       x_peek_auth_header(install_id, config_id),
-      {"pk-api-key", peek_app_key}
+      {"pk-api-key", peek_api_key}
     ]
   end
 

lib/peek_app_sdk/config.ex

@@ -14,15 +14,15 @@ defmodule PeekAppSDK.Config do
     peek_app_secret: "DEFAULT_SECRET",
     peek_app_id: "DEFAULT_APP_ID",
     peek_api_base_url: "https://apps.peekapis.com",
-    peek_app_key: "APP_KEY",
+    peek_api_key: "API_KEY",
     client_secret_token: "CLIENT_SECRET_TOKEN",
     apps: [
       project_name: [peek_app_id: "project_name_app_id", peek_app_secret: "project_name_secret", client_secret_token: "base64_key"],
       another_app: [peek_app_id: "another_app_id", peek_app_secret: "another_app_secret"]
     ]
   ```
 
-  Note that `peek_api_base_url` and `peek_app_key` are always taken from the default
+  Note that `peek_api_base_url` and `peek_api_key` are always taken from the default
   `:peek_app_sdk` configuration, regardless of which application identifier is used.
   """
 
@@ -32,7 +32,7 @@ defmodule PeekAppSDK.Config do
           client_secret_token: any(),
           peek_api_base_url: any(),
           peek_app_id: any(),
-          peek_app_key: any(),
+          peek_api_key: any(),
           peek_app_secret: any()
         }
   @doc """
@@ -48,7 +48,7 @@ defmodule PeekAppSDK.Config do
         peek_app_secret: "project_name_secret",
         peek_app_id: "project_name_app_id",
         peek_api_base_url: "https://apps.peekapis.com",
-        peek_app_key: "default_app_key"
+        peek_api_key: "default_api_key"
       }
 
   Using the default configuration:
@@ -58,10 +58,10 @@ defmodule PeekAppSDK.Config do
         peek_app_secret: "default_secret",
         peek_app_id: "default_app_id",
         peek_api_base_url: "https://apps.peekapis.com",
-        peek_app_key: "default_app_key"
+        peek_api_key: "default_api_key"
       }
 
-  Note that `peek_api_base_url` and `peek_app_key` are always taken from the default
+  Note that `peek_api_base_url` and `peek_api_key` are always taken from the default
   `:peek_app_sdk` configuration, regardless of which application identifier is used.
   """
   @spec get_config(atom() | nil) :: map()
@@ -74,7 +74,7 @@ defmodule PeekAppSDK.Config do
       peek_app_id: Application.get_env(:peek_app_sdk, :peek_app_id),
       peek_api_base_url:
         Application.get_env(:peek_app_sdk, :peek_api_base_url, @default_peek_api_base_url),
-      peek_app_key: Application.get_env(:peek_app_sdk, :peek_app_key),
+      peek_api_key: Application.get_env(:peek_app_sdk, :peek_api_key),
       client_secret_token: Application.get_env(:peek_app_sdk, :client_secret_token)
     }
   end
@@ -91,7 +91,7 @@ defmodule PeekAppSDK.Config do
         peek_app_id: Keyword.get(app_config, :peek_app_id),
         peek_api_base_url:
           Application.get_env(:peek_app_sdk, :peek_api_base_url, @default_peek_api_base_url),
-        peek_app_key: Keyword.get(app_config, :peek_app_key),
+        peek_api_key: Keyword.get(app_config, :peek_api_key),
         client_secret_token: Keyword.get(app_config, :client_secret_token)
       }
     else

lib/peek_app_sdk/metrics/client.ex

@@ -28,14 +28,14 @@ defmodule PeekAppSDK.Metrics.Client do
     }
 
     config = Config.get_config(config_id)
-    peek_app_key = config.peek_app_key
+    peek_api_key = config.peek_api_key
     peek_app_id = config.peek_app_id
     peek_api_base_url = config.peek_api_base_url
 
     url =
       "#{peek_api_base_url}/registry/installations/#{peek_app_id}/#{install_id}/configuration_status"
 
-    case Tesla.put!(client(), url, body, headers: headers(install_id, config_id, peek_app_key)) do
+    case Tesla.put!(client(), url, body, headers: headers(install_id, config_id, peek_api_key)) do
       %Tesla.Env{status: 200} ->
         :ok
 
@@ -169,10 +169,10 @@ defmodule PeekAppSDK.Metrics.Client do
     [x_peek_auth_header(install_id, config_id)]
   end
 
-  defp headers(install_id, config_id, peek_app_key) do
+  defp headers(install_id, config_id, peek_api_key) do
     [
       x_peek_auth_header(install_id, config_id),
-      {"pk-api-key", peek_app_key}
+      {"pk-api-key", peek_api_key}
     ]
   end
 

test/peek_app_sdk/client_test.exs

@@ -56,7 +56,7 @@ defmodule PeekAppSDK.ClientTest do
                end)
 
         assert Enum.any?(env.headers, fn {k, v} ->
-                 k == "pk-api-key" && v == "project_name_app_key"
+                 k == "pk-api-key" && v == "project_name_api_key"
                end)
 
         {:ok, %Tesla.Env{status: 200, body: %{data: response_data}}}
@@ -108,7 +108,7 @@ defmodule PeekAppSDK.ClientTest do
                Client.query_peek_pro(install_id, query, variables, :project_name)
     end
 
-    test "pk-api-key only sent if peek_app_key is set" do
+    test "pk-api-key only sent if peek_api_key is set" do
       install_id = "test_install_id"
       query = "query Test { test }"
       variables = %{"foo" => "bar"}

test/peek_app_sdk/config_test.exs

@@ -48,7 +48,7 @@ defmodule PeekAppSDK.ConfigTest do
       assert Map.has_key?(config, :client_secret_token)
       assert config.peek_app_secret == "project_name_app_secret"
       assert config.peek_app_id == "project_name_app_id"
-      assert config.peek_app_key == "project_name_app_key"
+      assert config.peek_api_key == "project_name_api_key"
       assert config.client_secret_token == "project_name_client_secret"
     end
 
@@ -60,7 +60,7 @@ defmodule PeekAppSDK.ConfigTest do
       assert Map.has_key?(config, :client_secret_token)
       assert config.peek_app_secret == "other_app_secret"
       assert config.peek_app_id == "other_app_id"
-      assert config.peek_app_key == nil
+      assert config.peek_api_key == nil
       assert config.client_secret_token == nil
     end