Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

Secure Webhook URLs

Since your Webhook Endpoint is on the open internet, you should take precautions to protect it from unwanted or malicious traffic. Use the following options either in isolation or in combination to secure your Endpoint.

Whitelist of IP Addresses

To ensure that your Endpoint does not receive notifications from unauthorized hosts, you can create a whitelist of Ocrolus IPs. Our current IPs for outbound Webhook requests are:

  • 18.205.30.63
  • 18.208.79.114
  • 18.213.224.210
  • 18.233.250.22
  • 35.173.140.133
  • 35.174.183.80
  • 54.164.238.206

HTTP Basic Authentication Scheme

HTTP Basic Authentication is another easy way to secure your Endpoint. Once set up is complete, simply include the relevant credentials in the Webhook URL registered with the system to activate this security feature.

curl -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: Basic dGVzdDZAb2Nyb2x1cy5jb206dGVzdGluZw==" \
    -d '{"webhook_endpoint" : "https://username:[email protected]/ocrolus/webhook", "event" : "BOOK_VERIFIED"}' \
    https://www.perfectaudit.com/api/v1/account/settings/update/webhook_endpoint

Updated about a year ago


Secure Webhook URLs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.