https://github.com/apitoolkit/apitoolkit-phoenix

APItoolkit's Elixir Phoenix client SDK.
https://github.com/apitoolkit/apitoolkit-phoenix

apitoolkit apitoolkit-sdk elixir elixir-lang elixir-phoenix

Last synced: about 17 hours ago
JSON representation

APItoolkit's Elixir Phoenix client SDK.

• Host: GitHub
• URL: https://github.com/apitoolkit/apitoolkit-phoenix
• Owner: apitoolkit
• License: mit
• Created: 2024-02-01T14:04:55.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-07-10T09:49:57.000Z (4 months ago)
• Last Synced: 2024-10-19T06:09:02.140Z (20 days ago)
• Topics: apitoolkit, apitoolkit-sdk, elixir, elixir-lang, elixir-phoenix
• Language: Elixir
• Homepage: https://apitoolkit.io/docs/sdks/elixir/phoenix/
• Size: 59.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only)

![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only)

## Phoenix SDK

[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=phoenixframework)](https://github.com/topics/apitoolkit-sdk) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/elixir/phoenix?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) 

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](#installation)

- [Configuration](#configuration)

- [Contributing and Help](#contributing-and-help)

- [License](#license)

---

## Installation

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

```elixir

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:

```elixir

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](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.




> [!IMPORTANT]

> 

> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/elixir/phoenix?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).

## 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](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).

- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).

- Create a [new issue](https://github.com/apitoolkit/apitoolkit-phoenix/issues/new/choose) in this repository.

## License

This repository is published under the [MIT](LICENSE) license.

---