Skip to main content

​
API Integration

The RxScale External Pharmacy API lets you automate your order processing workflow. Instead of manually managing orders through the Pharmacy Portal, you can connect your existing pharmacy systems directly to RxScale.

​
Overview

The External Pharmacy API allows you to:
  • Receive orders automatically — Get notified in real time when new orders are assigned to your pharmacy.
  • Update order statuses — Programmatically move orders through processing stages.
  • Manage stock levels — Keep your inventory in sync between your pharmacy system and RxScale.
  • Track shipments — Update shipping information through the API.
This is ideal for pharmacies that want to reduce manual work and integrate RxScale into their existing software and processes.

​
Setting Up API Keys

To use the API, you need an API key. You can manage your API keys from the API Access section of the Pharmacy Portal.
1

Go to API Access

Navigate to the API Access section from the sidebar.
2

Create an API key

Generate a new API key. Give it a descriptive name so you can identify it later (for example, “Pharmacy Management System Integration”).
3

Copy and store the key securely

Copy the API key and store it in a safe location. You will not be able to see the full key again after leaving this page.
Treat your API key like a password. Do not share it or expose it in public code repositories. If you believe your key has been compromised, revoke it immediately and create a new one.

​
Registering Webhooks

Webhooks let RxScale notify your system automatically when something happens, such as a new order being assigned to your pharmacy or an order being cancelled. To set up webhooks:
  1. Navigate to the API Access section of the Pharmacy Portal.
  2. Add a webhook endpoint URL — this is a URL on your server where RxScale will send notifications.
  3. Select the event types you want to receive (for example, new orders, status changes).
  4. Save your webhook configuration.
Once configured, RxScale will send an HTTP POST request to your endpoint whenever a relevant event occurs.
Make sure your webhook endpoint is publicly accessible and responds with a 200 status code to acknowledge receipt. See the Webhooks documentation for details on payload formats and security.

​
Automating Order Processing

With the API and webhooks in place, you can build an automated workflow:
  1. Receive a webhook notification when a new order is assigned to your pharmacy.
  2. Fetch the order details using the API to get the full order information.
  3. Process the order in your pharmacy system (check stock, prepare medication).
  4. Update the order status through the API as you move through each processing step.
  5. Add shipping information once the order is shipped.
This automation eliminates the need to manually check the Pharmacy Portal for new orders and manually update statuses.

​
Full API Reference

For complete API documentation, including all available endpoints, request formats, and response schemas, see the External Pharmacy API Reference.