Skip to main content

Developer API

The IsleBooks Developer API allows you to integrate IsleBooks with your own applications, websites, mobile apps, and third-party systems.

Using the API, developers can securely access and manage business data such as products, contacts, purchases, sales, inventory, deliveries, and more.

Note: The Developer API requires the Developer API add-on to be enabled for your business.


Enabling the Developer API

  1. Go to Developer Portal.

  2. Subscribe to or enable the Developer API add-on.

  3. Once activated, you can begin creating API keys.

The Developer Portal also provides:

  • API Keys

  • Webhooks

  • WooCommerce Integration

  • API Documentation

  • API Usage Analytics


Creating an API Key

  1. Open the API Keys tab.

  2. Click Issue New Key.

  3. Enter a descriptive name for the key.

  4. Select the required API permissions (scopes).

  5. Save the key.

Store your API key securely. It is required to authenticate API requests.


Webhooks

The Webhooks tab allows you to receive real-time notifications when supported events occur in IsleBooks.

Examples include:

  • Product changes

  • Contact changes

  • Sales

  • Purchases

  • Payment submissions

Webhooks can be used to synchronize external applications without continuously polling the API.


API Documentation

Complete API documentation is available directly from the API Docs tab.

The documentation includes:

  • Available endpoints

  • Authentication

  • Request and response examples

  • Supported parameters

  • Error responses

  • Interactive API testing

  • OpenAPI specification

You can also download the OpenAPI specification or open the full interactive API reference from this page.


API Analytics

The Developer Portal provides usage statistics for your API integration, including:

  • API calls over time

  • Most frequently used endpoints

  • Response status codes

  • API key activity

  • Request rate information

These analytics help monitor API usage and troubleshoot integrations.


WooCommerce Integration

The WooCommerce tab allows you to connect IsleBooks with your WooCommerce store.

Refer to the WooCommerce Integration guide for setup instructions.


Best Practices

  • Create separate API keys for different applications.

  • Grant only the permissions required by each integration.

  • Keep API keys private and never expose them in public repositories or client-side applications.

  • Use Webhooks whenever possible for real-time synchronization.

  • Refer to the API Docs tab for the latest endpoints, request formats, and integration examples.

Did this answer your question?