Getting Started
Getting Started with DoseSpot API
This section walks you through everything you need to begin using DoseSpot’s RESTful API in your integration.
1. Request API Credentials
Contact you DoseSpot client integration specialist or account manager to obtain:
- Subscription Key (for Ocp-Apim-Subscription-Key header)
- DoseSpot's Authentication guide
2. Set Up Your Environment
Use the appropriate base URL:
- Staging:
https://staging.dosespot.com/webapi/v2 - Production: Contact DoseSpot to obtain
Ensure you have:
- HTTPS client capable of sending custom headers
- Secure storage for API credentials
3 HTTP Specifics
DoseSpot’s API follows RESTful conventions and uses standard HTTP methods:
| HTTP Method | Definition |
|---|---|
| GET | Retrieve a resource or list of resources |
| POST | Create a new resource or perform an action |
| PUT | Update an existing resource |
| DELETE | Remove a resource |
Note: PUT is the preferred method for editing existing resources and DELETE is the preferred method for deleting existing resources. In the case in which your technology does not support PUT or DELETE methods, the same results can be obtained using the POST method.
Both JSON and XML formats are supported by the DoseSpot RESTful API
4 String Properties
General Information
- All string fields are case-insensitive unless otherwise specified.
- Trim whitespace from input fields before sending requests.
- Maximum string lengths are enforced; exceeding them will result in a 400 response.
- The following special characters are supported: .!"#$%&'()*+,-/:;<=>?@[]^_`{|}~
Specific Field Requirements
| Field | Requirements |
|---|---|
| State | Must be a two-character U.S. state abbreviation (e.g., MA, CA) or full name. |
| ZIP Code | 5-digit or 9-digit ZIP (ZIP+4 accepted without hyphen) |
| Phone Numbers | Numeric only, formatted for the United States; 10 digits required. Extenstions are allowed by using an "x" before them. All area codes are suppored with the exception of "555" and codes that sart with "0" or "1". Cannot contain 7 or more repeated numbers |
Follow these requirements carefully to prevent validation failures during clinician, patient, or prescription creation.
7. Explore the API Guide
Use the API guide to explore available resources. The API guide is connected directly to DoseSpot's API codebase and is automatically updated when code changes.
There are two API collections linked:
*Note Not all endpoints in the API guide may be necessary to use. The extra calls depend on if you plan to certify to use EPCS through DoseSpot.