Skip to content

DocSpring API client for Elixir / Phoenix applications

License

Notifications You must be signed in to change notification settings

DocSpring/docspring-elixir

Repository files navigation

Docspring

DocSpring provides an API that helps you fill out and sign PDF templates.

Building

To install the required dependencies and to build the elixir project, run:

mix local.hex --force
mix do deps.get, compile

Installation

If available in Hex, the package can be installed by adding docspring to your list of dependencies in mix.exs:

def deps do
  [{:docspring, "~> 2.0.0"}]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/docspring.

Configuration

You can override the URL of your server (e.g. if you have a separate development and production server in your configuration files).

config :docspring, base_url: "https://sync.api.docspring.com/api/v1"

Multiple clients for the same API with different URLs can be created passing different base_urls when calling Docspring.Connection.new/1:

client = Docspring.Connection.new(base_url: "https://sync.api.docspring.com/api/v1")

About

DocSpring API client for Elixir / Phoenix applications

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages