Phoenix SDK

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Elixir Phoenix application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.

---

Table of Contents

• Installation
• Configuration
• Contributing and Help
• License

---

Installation

To install the SDK, kindly add apitoolkit_phoenix to your list of dependencies in the mix.exs file like so:

def deps do
  [
    {:apitoolkit_phoenix, "~> 0.1.1"}
  ]
end

Then, run the mix deps.get command to install the apitoolkit_phoenix dependency.

Configuration

Next, import and initialize the ApitoolkitPhoenix Plug in your router.ex file like so:

defmodule HelloWeb.Router do
  use HelloWeb, :router
  use Plug.ErrorHandler
  import ApitoolkitPhoenix

  pipeline :api do
    plug :accepts, ["json"]
    # Other plugs
    plug ApitoolkitPhoenix,
      config: %{
        api_key: "{ENTER_YOUR_API_KEY_HERE}",
        debug: false,
      }
  end
end

Note

The {ENTER_YOUR_API_KEY_HERE} demo string should be replaced with the API key generated from the APItoolkit dashboard.

Important

To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this SDK documentation.

Contributing and Help

To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:

• Read our Contributors Guide.
• Join our community Discord Server.
• Create a new issue in this repository.

License

This repository is published under the MIT license.

---