Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blazingdocs/blazingdocs-ruby
BlazingDocs Ruby client
https://github.com/blazingdocs/blazingdocs-ruby
api csv doc document-generation documents docx json mail-merge odt pdf reports templates xml
Last synced: 3 days ago
JSON representation
BlazingDocs Ruby client
- Host: GitHub
- URL: https://github.com/blazingdocs/blazingdocs-ruby
- Owner: blazingdocs
- License: mit
- Created: 2021-08-20T13:43:33.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-16T16:40:26.000Z (over 2 years ago)
- Last Synced: 2024-08-10T21:21:47.674Z (about 2 months ago)
- Topics: api, csv, doc, document-generation, documents, docx, json, mail-merge, odt, pdf, reports, templates, xml
- Language: Ruby
- Homepage: https://blazingdocs.com
- Size: 67.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BlazingDocs Ruby client
High-performance document generation API. Generate documents and reports from СSV, JSON, XML with 99,9% uptime and 24/7 monitoring.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'blazingdocs'
```
## Integration basics
### Setup
You can get your API Key at https://app.blazingdocs.com
```ruby
client = BlazingDocs.create_client('api-key')
```
### Getting account info
```ruby
account = client.get_account
```
### Getting merge templates list
```ruby
templates = client.get_templates
# with parent folder path
templates = client.get_templates('parentfolder')
```
### Getting usage info
```ruby
usage = client.get_usage
```
### Executing merge
```ruby
data = File.open('PO-Template.json').read
template = File.open('PO-Template.docx')
merge_parameters = BlazingDocs::MergeParameters.new
merge_parameters.sequence = false # data is object
merge_parameters.data_source_type = 'json' # data in json format
merge_parameters.strict = true # keep json types
merge_result = client.merge(data, 'output.pdf', merge_parameters, template)
```
## Documentation
See more details here https://docs.blazingdocs.com