### DocRaptor Getting Started
Source: https://docraptor.com/documentation/article/8562569-annotations-comments
Guides for getting started with DocRaptor, covering installation, key concepts, integrations, account management, and security.
```APIDOC
Getting Started:
Installation: https://docraptor.com/documentation
Key Concepts: https://docraptor.com/documentation/getting_started/key_concepts
Integrations: https://docraptor.com/documentation/getting_started/integrations
Account & Billing: https://docraptor.com/documentation/account_and_billing
Security & Privacy: https://docraptor.com/security-and-privacy
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/tutorial/table-of-contents
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "
Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/1067976-links
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/8358166-cross-references
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/6263548-2022-05-02-soc2-compliance
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/2169220-ssl-tls-issues
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### Ruby HTML-to-PDF Setup and Examples
Source: https://docraptor.com/documentation/ruby
Provides guidance on setting up and using Ruby for HTML-to-PDF conversion with DocRaptor. Includes installation instructions, a 'Hello World!' example, an advanced usage example, API parameter details, HTML & CSS guides, and general documentation resources.
```Ruby
## Ruby HTML-to-PDF
### Installation
[Installation](https://docraptor.com/documentation/ruby#setup)
### Hello World! Example
[Hello World! Example](https://docraptor.com/documentation/ruby#hello-world)
### Advanced Example
[Advanced Example](https://docraptor.com/documentation/ruby#advanced)
### API Parameters
[API Parameters](https://docraptor.com/documentation/ruby#parameters)
### HTML & CSS Guides
[HTML & CSS Guides](https://docraptor.com/documentation/ruby#guides)
### Documentation & Resources
[Documentation & Resources](https://docraptor.com/documentation/ruby#documentation)
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/1067570-footnotes
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### Quick Start Guides
Source: https://docraptor.com/documentation/tutorial/page-numbers
These guides provide step-by-step instructions for integrating DocRaptor into your projects using various programming languages. They cover setup, basic usage, and common scenarios.
```APIDOC
Quick Start Guides:
Java:
- Install the DocRaptor Java client library.
- Authenticate using your API key.
- Use the provided methods to generate documents from HTML or URLs.
- Example: `DocRaptor.newDocument(apiKey, "pdf", "Java Example
")`
JavaScript (Node.js):
- Install the DocRaptor Node.js package (`npm install docraptor`).
- Require the package and initialize with your API key.
- Call the `create` method with document details.
- Example: `const docraptor = require('docraptor'); docraptor.create({ ... });`
Python:
- Install the DocRaptor Python client (`pip install docraptor`).
- Import the library and set your API key.
- Use the `create` function to generate documents.
- Example: `docraptor.create(key=api_key, document_type='pdf', document_content='...')`
Ruby:
- Install the DocRaptor Ruby gem (`gem install docraptor`).
- Require the gem and configure your API key.
- Use the `DocRaptor.create` method.
- Example: `DocRaptor.create(key: api_key, ...)`
.NET:
- Integrate the DocRaptor .NET library.
- Configure your API key.
- Utilize the provided classes and methods for document generation.
PHP:
- Include the DocRaptor PHP library.
- Set your API key.
- Use the `DocRaptor` class methods to create documents.
jQuery:
- Use the DocRaptor JavaScript API with jQuery.
- Make AJAX requests to the DocRaptor API endpoint.
- Handle responses to download or display generated documents.
```
--------------------------------
### Ruby Quick Start
Source: https://docraptor.com/documentation/article/5174403-2014-04-11-improved-document-usage-dashboard
Guides Ruby developers on integrating DocRaptor for PDF generation. Includes setup instructions and code examples for creating PDFs.
```Ruby
require 'docraptor'
api_key = ENV['DOCRAPTOR_API_KEY']
if api_key.nil?
puts 'DOCRAPTOR_API_KEY environment variable not set.'
exit
end
doc_api = DocRaptor::DocApi.new
hTML_content = "Hello from Ruby!
This is a PDF generated using DocRaptor.
"
doc_options = {
:document_content => hTML_content,
:name => 'my_document.pdf',
:document_type => 'pdf',
:test => true
}
begin
pdf_bytes = doc_api.create_doc(doc_options)
File.open('output.pdf', 'wb') do |f|
f.write(pdf_bytes)
end
puts 'PDF generated successfully and saved as output.pdf'
rescue DocRaptor::DocRaptorError => e
puts "Error creating PDF: #{e.message}"
end
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/1068675-code-example-automatic-section-sub-sectioning-numbering
Provides quick start instructions for integrating DocRaptor with various programming languages. Includes setup and basic usage examples for common platforms.
```APIDOC
Quick Start:
- Java:
[ View Java Documentation ](https://docraptor.com/documentation/java)
- JavaScript:
[ View JavaScript Documentation ](https://docraptor.com/documentation/jquery)
- jQuery:
[ View jQuery Documentation ](https://docraptor.com/documentation/jquery)
- .NET:
[ View .NET Documentation ](https://docraptor.com/documentation/dotnet)
- Node:
[ View Node Documentation ](https://docraptor.com/documentation/node)
- PHP:
[ View PHP Documentation ](https://docraptor.com/documentation/php)
- Python:
[ View Python Documentation ](https://docraptor.com/documentation/python)
- Ruby:
[ View Ruby Documentation ](https://docraptor.com/documentation/ruby)
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/5174773-2016-11-21-pipeline-5
Links to quick start guides for integrating DocRaptor with various programming languages and frameworks.
```html
Java
JavaScript
jQuery
.NET
Node
PHP
Python
Ruby
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/1067094-headers-footers
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/pdf_generation/troubleshooting
Provides quick start instructions and code examples for integrating DocRaptor with various programming languages.
```APIDOC
Quick Start Guides:
Java:
- Link: https://docraptor.com/documentation/java
- Description: Instructions and examples for using DocRaptor with Java applications.
JavaScript:
- Link: https://docraptor.com/documentation/jquery
- Description: Examples for integrating DocRaptor using JavaScript, often with jQuery.
.NET:
- Link: https://docraptor.com/documentation/dotnet
- Description: Guidance for .NET developers to use the DocRaptor API.
Node.js:
- Link: https://docraptor.com/documentation/node
- Description: Node.js specific examples and integration patterns.
PHP:
- Link: https://docraptor.com/documentation/php
- Description: PHP code snippets and setup instructions.
Python:
- Link: https://docraptor.com/documentation/python
- Description: Python examples for PDF generation with DocRaptor.
Ruby:
- Link: https://docraptor.com/documentation/ruby
- Description: Ruby on Rails and other Ruby integration examples.
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/1053040-api-limits
Guides to help you get started with DocRaptor using various programming languages. These examples demonstrate basic document generation.
```APIDOC
Quick Start Guides:
Java:
- Include the DocRaptor Java client library.
- Instantiate the DocRaptor client with your API key and secret.
- Use the `createDoc` method with your HTML content and desired document type.
- Example:
```java
import com.docraptor.DocRaptor;
public class Main {
public static void main(String[] args) {
DocRaptor client = new DocRaptor("YOUR_API_KEY", "YOUR_API_SECRET");
String html = "Hello from Java!
";
byte[] pdf = client.createDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
JavaScript (Node.js):
- Install the DocRaptor Node.js package: `npm install docraptor`.
- Require the package and create a client instance.
- Use the `createDoc` method.
- Example:
```javascript
const DocRaptor = require('docraptor');
const client = new DocRaptor('YOUR_API_KEY', 'YOUR_API_SECRET');
const html = 'Hello from Node.js!
';
client.createDoc(html, 'pdf', function(err, pdf) {
if (err) throw err;
// Save the pdf buffer to a file
});
```
Python:
- Install the DocRaptor Python client library: `pip install docraptor`.
- Import the `DocRaptor` class.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```python
from docraptor import DocRaptor
client = DocRaptor(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
html = 'Hello from Python!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf bytes to a file
```
Ruby:
- Install the DocRaptor Ruby gem: `gem install docraptor`.
- Require the gem.
- Create a client instance.
- Use the `create_doc` method.
- Example:
```ruby
require 'docraptor'
client = DocRaptor::DocRaptor.new('YOUR_API_KEY', 'YOUR_API_SECRET')
html = 'Hello from Ruby!
'
pdf = client.create_doc(html, 'pdf')
# Save the pdf to a file
```
.NET:
- Add the DocRaptor .NET client library to your project.
- Create a `DocRaptorClient` instance.
- Call the `CreateDoc` method.
- Example:
```csharp
using DocRaptor;
public class Example {
public static void Main(string[] args) {
var client = new DocRaptorClient("YOUR_API_KEY", "YOUR_API_SECRET");
string html = "Hello from .NET!
";
byte[] pdf = client.CreateDoc(html, "pdf");
// Save the pdf byte array to a file
}
}
```
PHP:
- Include the DocRaptor PHP library.
- Create a `DocRaptor` client instance.
- Use the `createDoc` method.
- Example:
```php
Hello from PHP!';
$pdf = $client->createDoc($html, 'pdf');
// Save the pdf content to a file
?>
```
jQuery:
- Include the DocRaptor jQuery plugin.
- Use the `docraptor` function to create documents.
- Example:
```javascript
$.ajax({
url: 'https://api.docraptor.com/v1/documents',
type: 'POST',
beforeSend: function(xhr) {
xhr.setRequestHeader('Authorization', 'Basic ' + btoa('YOUR_API_KEY:YOUR_API_SECRET'));
},
contentType: 'application/json',
data: JSON.stringify({ doc: { document_content: 'Hello from jQuery!
', document_type: 'pdf' } }),
success: function(response) {
console.log('Document created:', response);
},
error: function(err) {
console.error('Error creating document:', err);
}
});
```
```
--------------------------------
### DocRaptor Quick Start Guides
Source: https://docraptor.com/documentation/article/1068667-code-example-jquery-data-tables
Provides quick start instructions and code examples for integrating DocRaptor with various programming languages.
```APIDOC
Quick Start Guides:
Java:
[ https://docraptor.com/documentation/java ]
JavaScript:
[ https://docraptor.com/documentation/jquery ]
jQuery:
[ https://docraptor.com/documentation/jquery ]
.NET:
[ https://docraptor.com/documentation/dotnet ]
Node:
[ https://docraptor.com/documentation/node ]
PHP:
[ https://docraptor.com/documentation/php ]
Python:
[ https://docraptor.com/documentation/python ]
Ruby:
[ https://docraptor.com/documentation/ruby ]
```