documentation.telegramd.com Open in urlscan Pro
44.196.206.22  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Telegra API
Introduction
Set Language of Code Snippets
Enabling API Access
API Rate Limits
Errors
Data Models
Authentication
Prospect Patient
Products
Orders
Webhooks


TELEGRA API

The TelegraMD API is organized around REST Protocol. All calls to the TelegraMD
API should be made to the base url. The base URL will change depending on the
environment. These environment variables will be provided to you during
onboarding . All responses are formatted in JSON.


SET LANGUAGE OF CODE SNIPPETS

The example code snippets shown on the side of each endpoint's description can
be changed. At the very top of the documentation, select the dropdown titled
"Language". The list contains many common programming languages and libraries to
help get things started!


ENABLING API ACCESS

To begin using the TelegraMD API, you must receive API access and credentials
from your account executive. After validating your business and/or operation, we
will grant you an affiliate account that will allow you to make API calls.


API RATE LIMITS

Rate limit is the number of API calls a user can make within a given time period
per API token. TelegraMD restricts API requests when you exceed the limit of 60
calls per minute.

You can check the current application rate limit usage in response headers:

Key Type Value Description X-RateLimit-Limit number 60 Total limit
X-RateLimit-Remaining number 59 Remaining API calls X-RateLimit-Reset number
1614597318 Timestamp when limit will reset

When the upper limit is breached, an HTTP 429 error response is returned for
subsequent requests. As a result, no more requests are served until the limit
resets (within one minute).


ERRORS

The TeleMD Now API uses the following error codes:

Error Code Meaning 400 Invalid Input 401 Unauthorized 403 Forbidden 404 Not
Found 405 Method Not Allowed 429 Too Many Requests 500 Internal Server Error 503
Service Unavailable


DATA MODELS


ADDRESS

An address contains both the billing and shipping address

The top level address object has two fields: billing and shipping

Parameter Type billing Address shipping Address

Both the Billing and Shipping attributes are of type Address. If a billing
address is not applicable, please copy the shipping address and use for the
billing address. Here is an example.

Parameter NameData TypeExampleRequired

Parameter Name Data Type Example Required address1 string 123 Jedi Lane true
address2 string Apt. 4 false city string Tatooine true state string Texas or TX
or
(Can be US 2-character abbreviation or state name or Telegra state id) true
zipcode string 10892
(should be in 5 digit zipcode format) true