BookFunnel API

Request

Base URL

https://api.bookfunnel.com/v1

Arguments

All arguments are passed as simple POST parameters in the request.

Response

All responses are formatted as JSON and have application/json as the Content-Type.

HTTP Status Codes

BookFunnel uses these HTTP response codes:

HTTP CodeDescription
200OK
400Bad Request
410Invalid API Key
500Internal Server Error

Response With Error

Every error has the structure described below.

{
  "status": "ERR",
  "message": "Error message"
  "code": Error Code
}

Authenticating

Send your BookFunnel API key in the X-BookFunnel-APIKey header. To obtain an API key, contact support@bookfunnel.com.

Reference

Sending Books

Create a unique link against an opt-in landing page on BookFunnel and return that unique link. This is useful for sending your own emails from your system. BookFunnel will generate the link against the page, but no email will be sent.

PARAMS

ParameterDescription
objectThe email signup link from BookFunnel that the reader’s link will be generated against (required)
emailThe reader’s email address (required)

Response

{
  "status": "OK",
  "message": "Link created.",
  "link": Reader's download link,
  "code": Reader's download code
}

Create a unique link against an opt-in landing page on BookFunnel and then email that link to the reader.

PARAMS

ParameterDescription
objectThe email signup link from BookFunnel that the reader’s link will be generated against (required)
emailThe reader’s email address (required)
first_nameThe reader’s first name (optional)
last_nameThe reader’s last name (optional)
subjectThe subject line you want in the email (optional)

Default:
Here’s “{{title}}” by {{author}}
headingThe heading you would like to include at the top of the email (optional)

Default:
{{book_title}}
messageThe message you would like to include in the email (optional)

Default:
If you have any trouble getting your book, click the help link at the top of the page. Someone from our support team will be happy to lend a hand!

Response

{
  "status": "OK",
  "message": "Email queued.",
  "link": Reader's download link,
  "code": Reader's download code
}

API Testing

/v1/test

Test your API key and receive a response.

Response

{
  "status": "OK",
  "message": "Looks good!",
  "name": Account holder's name,
  "email": Account holder's email
}

Was this article helpful?

Need Help?
Can’t find the answer you’re looking for?
CONTACT SUPPORT