Popularity
1.1
Growing
Activity
0.0
Stable
4
1
1

Description

An Elixir wrapper for the Zendesk API.

Monthly Downloads: 0
Programming language: Elixir
License: MIT License
Tags: Third Party APIs     Http Client     Zendesk    

Zendex alternatives and similar packages

Based on the "Third Party APIs" category.
Alternatively, view Zendex alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of Zendex or a related project?

Add another 'Third Party APIs' Package

README

Zendex

Build Status Coverage Status Ebert Hex.pm version Hex.pm downloads Hex.pm license Libraries.io dependencies

An Elixir wrapper for the Zendesk API.

ExDoc Documentation

Installation

  1. Add zendex to your list of dependencies in mix.exs:

    def deps do
      [{:zendex, "~> 0.8.1"}]
    end
    
  2. Ensure zendex is started before your application:

    def application do
      [applications: [:zendex]]
    end
    

Usage

  1. Setup a Zendex.Connection map, that will store your Zendesk details. It requires the URL of your Zendesk instance, your username and your password.
  iex> conn = Zendex.Connection.setup("http://test.zendesk.com", "User1", "pass")
  %{authentication: "VXNlcjE6cGFzcw==", base_url: "http://test.zendesk.com"}
  1. Make use of the other modules to do various actions on your Zendesk. Example of showing a user:
  iex> Zendex.User.show(conn, 1)
  %{"user": %{"id": 87, "name": "Quim Stroud", ...}}
  1. Using pipes:
  "http://test.zendesk.com"
  |> Zendex.Connection.setup("Username1", "password123")
  |> Zendex.User.show(101)

Completeness and Contributions

This package far from complete in terms of utilising all of the Zendesk API, any contributions will be welcome. Please keep the code consistent with what I have already written here.


*Note that all licence references and agreements mentioned in the Zendex README section above are relevant to that project's source code only.