Overview
Integration with Align allows labs have the iTero scans as an integral part of their offices.
Labs can get iTero scans into their case manager/LMS, so they have all cases managed in one system.
Authentication and Pairing APIs¶
| Name | Description | How and When to Use | Comments |
|---|---|---|---|
| Authorization | Provide Align's credentials to the system | Allow generic APIs to be used by registered users only | / |
| Get Token | Get a token to be used for pairing | Token is required for pairing process | Two tokens are returned: access token and refresh token. Access token is used for the next steps |
| Refresh Token | Refresh a token that expired | Token expires after one hour and has to be refreshed to allow continuous work | Refresh token should be passed to receive new access token |
| Revoke Token | Stop using a token | Similar to a log out operation | / |
| Discovery | Receive Regional URLs for API calls | Before Get Available Companies for Pairing. Before calls to Refresh Token |
For more information about the Discovery API, please refer to the "Authentication and Pairing Process V2" specification |
| Get Accounts for pairing | User gets a list of accounts available to pair to | User selects the account to pair to | / |
| Pair | User pairs to a selected account | User will be able to work with orders that are related to the account he selected | A new set of tokens is provided |
| Un Pair | Pairing is terminated after this call | When user wishes to stop working with this account | / |
Lab Connector APIs¶
| Name | Description | In more details | Comments |
|---|---|---|---|
| Get Orders | Returns list of orders that were sent to the Lab | Lab will get in the list new orders only. Orders that were downloaded will not be included in the list | / |
| Scan notification (webhook) | A push mechanism to notify the lab that a scan is ready | Allows Labs to use a 'Push' mechanism in which a notification is sent with every scan that is ready. | Ready order is a scan that:
|
| Get Order By RxID | Returns order's metadata whose RxId is provided to the API | Returns the same metadata as in 'Get Orders' for one specific order with the provided RxID. User should use it when using the Scan Notification webhook. Scan notification is triggered when a scan is ready. The data received in the notification is RxID only. |
/ |
| Download Order | Download scan artifacts for scan whose order ID is provided | Download a scan to DPMS. User can download all scan files or just 'thumbnails' for an order with the provided order ID. | Full scan:
|
| Return to doctor | Return a scan to the doctor for re-scan | If the lab needs the doctor to re-scan a patient it can return the order to the doctor | / |
Lab Connector Flow¶
