https://github.com/filepreviews/filepreviews-elixir
Elixir client library for FilePreviews.io
https://github.com/filepreviews/filepreviews-elixir
elixir filepreviews
Last synced: 18 days ago
JSON representation
Elixir client library for FilePreviews.io
- Host: GitHub
- URL: https://github.com/filepreviews/filepreviews-elixir
- Owner: filepreviews
- License: mit
- Created: 2015-08-03T11:33:23.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-10-20T11:05:05.000Z (over 7 years ago)
- Last Synced: 2026-05-16T16:21:28.532Z (about 1 month ago)
- Topics: elixir, filepreviews
- Language: Elixir
- Homepage: http://filepreviews.io
- Size: 17.6 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FilePreviews.io
[![build-status-image]][travis]
[![hexpm-version]][hexpm]
Elixir client library for [FilePreviews.io][filepreviews]. Generate image previews and metadata from almost any kind of file.
## Installation
```elixir
{:filepreviews, "~> 1.0.0"}
```
## Usage
```elixir
{:ok, filepreviews} = FilePreviews.new("API_KEY", "API_SECRET")
```
### Generate
```elixir
# status is either :ok or :error
# response is a Map converted from the JSON response from FilePreviews.
{status, response} = FilePreviews.generate("http://example.com/file.pdf")
```
#### Options
Check out the [endpoint docs][endpoint_docs] for all available options.
```elixir
params = %{metadata: ["exif"], pages: "1"}
{status, response} = FilePreviews.generate("http://example.com/file.pdf", params)
```
### Retrieve
```elixir
{status, response} = FilePreviews.retrieve("42764e04-9094-467c-96b3-49d31ff4423d")
```
[build-status-image]: https://travis-ci.org/GetBlimp/filepreviews-elixir.svg?branch=master
[travis]: http://travis-ci.org/GetBlimp/filepreviews-elixir?branch=master
[hexpm-version]: https://img.shields.io/hexpm/v/filepreviews.svg
[hexpm]: https://hex.pm/packages/filepreviews
[filepreviews]: http://filepreviews.io
[endpoint_docs]: https://filepreviews.io/docs/endpoints/