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

Protecting your Webhook Endpoint

Since your Webhook Endpoint is on the open internet, you must protect the Endpoint from unwanted or malicious traffic. Use one or more of the following options to secure your Endpoint.

Whitelist of IP Addresses

To prevent your Endpoint from receiving notifications from unauthorized hosts, create a whitelist of Ocrolus IPs.

Ocrolus IPs for outbound Webhook requests:

  • 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.
To activate this security feature, after completing set up, include the relevant credentials in the Webhook URL registered with the system .

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 month 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.