diff --git a/api-reference/doc-tool/ip-allowlisting-for-clients.mdx b/api-reference/doc-tool/ip-allowlisting-for-clients.mdx new file mode 100644 index 0000000..0429f75 --- /dev/null +++ b/api-reference/doc-tool/ip-allowlisting-for-clients.mdx @@ -0,0 +1,24 @@ +--- +title: IP Allowlisting for Clients +description: Allowlisting and endpoint information to access Eka Care EMR +--- + +Ensure your network/firewall is configured to allow inbound connections from the below URLs for seamless integration with Eka Care EMR. + +## Production +- **Allowed URLs:** + - `*.eka.care` + +## Staging +- **Allowed URLs:** + - `*.dev.eka.care` + +## S3 Bucket URLs + +- `*.s3.ap-south-1.amazonaws.com` + + +--- + +> eka.care and dev.eka.care URL's are hosted on AWS Cloudfront, Make sure you have allowlisted [AWS CloudFront IP Addresses.](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/LocationsOfEdgeServers.html) + diff --git a/api-reference/doc-tool/ip-allowlisting-for-clients.yaml b/api-reference/doc-tool/ip-allowlisting-for-clients.yaml new file mode 100644 index 0000000..8b0343b --- /dev/null +++ b/api-reference/doc-tool/ip-allowlisting-for-clients.yaml @@ -0,0 +1,76 @@ +openapi: 3.0.0 +info: + title: Doctor Tool IP Allowlisting Information + description: Allowlisting and endpoint information to access Eka Care EMR + version: 1.0.0 + contact: + name: Eka Care Support + url: https://eka.care/ + email: support@eka.care + +servers: + - url: https://api.eka.care + description: Production server - Allowed URL pattern *.eka.care + - url: https://api.dev.eka.care + description: Staging server - Allowed URL pattern *.dev.eka.care + +tags: + - name: Network Configuration + description: IP allowlisting and network configuration requirements + +paths: + /network-info: + get: + tags: + - Network Configuration + summary: Get Network Configuration Requirements + description: | + Ensure your network/firewall is configured to allow inbound connections from the below URLs for seamless integration with Eka Care EMR. + + ## Production Environment + - **Allowed URLs:** `*.eka.care` + + ## Staging Environment + - **Allowed URLs:** `*.dev.eka.care` + + ## S3 Bucket URLs + - `*.s3.ap-south-1.amazonaws.com` + + ## Important Notes + - eka.care and dev.eka.care URLs are hosted on AWS CloudFront + - Make sure you have allowlisted [AWS CloudFront IP Addresses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/LocationsOfEdgeServers.html) + responses: + 200: + description: Network configuration information + content: + application/json: + schema: + type: object + properties: + production: + type: object + properties: + urls: + type: array + items: + type: string + example: ["*.eka.care"] + s3_buckets: + type: array + items: + type: string + example: ["*.s3.ap-south-1.amazonaws.com"] + staging: + type: object + properties: + urls: + type: array + items: + type: string + example: ["*.dev.eka.care"] + s3_buckets: + type: array + items: + type: string + example: ["*.s3.ap-south-1.amazonaws.com"] + diff --git a/api-reference/health-ai/ekascribe/ip-allowlisting-for-clients.mdx b/api-reference/health-ai/ekascribe/ip-allowlisting-for-clients.mdx new file mode 100644 index 0000000..bd18cda --- /dev/null +++ b/api-reference/health-ai/ekascribe/ip-allowlisting-for-clients.mdx @@ -0,0 +1,34 @@ +--- +title: IP Allowlisting for Clients +description: Allowlisting and endpoint information for Eka Scribe APIs & Audio transcription +--- + +Ensure your network/firewall is configured to allow inbound connections from the below URLs for seamless integration with Eka Scribe & audio transcription APIs. + +## Production +- **Allowed URLs:** + - `*.eka.care` + +## Staging +- **Allowed URLs:** + - `*.dev.eka.care` + +## S3 Bucket URLs + +### Production +``` +https://m-prod-voice-record.s3.ap-south-1.amazonaws.com +https://m-prod-voice2rx-batch.s3.ap-south-1.amazonaws.com +https://m-prod-ekascribe-batch.s3.amazonaws.com +``` + +### Staging +``` +https://m-dev-voice-record.s3.ap-south-1.amazonaws.com +https://m-dev-voice2rx-batch.s3.ap-south-1.amazonaws.com +``` + +--- + +> eka.care is hosted on AWS Cloudfront, Make sure you have allowlisted [AWS CloudFront IP Addresses.](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/LocationsOfEdgeServers.html) + diff --git a/api-reference/health-ai/ekascribe/ip-allowlisting-for-clients.yaml b/api-reference/health-ai/ekascribe/ip-allowlisting-for-clients.yaml new file mode 100644 index 0000000..d32f1b5 --- /dev/null +++ b/api-reference/health-ai/ekascribe/ip-allowlisting-for-clients.yaml @@ -0,0 +1,88 @@ +openapi: 3.0.0 +info: + title: EkaScribe IP Allowlisting Information + description: Allowlisting and endpoint information for Eka Scribe APIs & Audio transcription + version: 1.0.0 + contact: + name: Eka Care Support + url: https://eka.care/ + email: support@eka.care + +servers: + - url: https://api.eka.care + description: Production server - Allowed URL pattern *.eka.care + - url: https://api.dev.eka.care + description: Staging server - Allowed URL pattern *.dev.eka.care + +tags: + - name: Network Configuration + description: IP allowlisting and network configuration requirements + +paths: + /network-info: + get: + tags: + - Network Configuration + summary: Get Network Configuration Requirements + description: | + Ensure your network/firewall is configured to allow inbound connections from the below URLs for seamless integration with Eka Scribe & audio transcription APIs. + + ## Production Environment + - **Allowed URLs:** `*.eka.care` + + ## Staging Environment + - **Allowed URLs:** `*.dev.eka.care` + + ## S3 Bucket URLs + + ### Production + - `https://m-prod-voice-record.s3.ap-south-1.amazonaws.com` + - `https://m-prod-voice2rx-batch.s3.ap-south-1.amazonaws.com` + - `https://m-prod-ekascribe-batch.s3.amazonaws.com` + + ### Staging + - `https://m-dev-voice-record.s3.ap-south-1.amazonaws.com` + - `https://m-dev-voice2rx-batch.s3.ap-south-1.amazonaws.com` + + ## Important Notes + - eka.care is hosted on AWS CloudFront + - Make sure you have allowlisted [AWS CloudFront IP Addresses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/LocationsOfEdgeServers.html) + responses: + 200: + description: Network configuration information + content: + application/json: + schema: + type: object + properties: + production: + type: object + properties: + urls: + type: array + items: + type: string + example: ["*.eka.care"] + s3_buckets: + type: array + items: + type: string + example: + - "https://m-prod-voice-record.s3.ap-south-1.amazonaws.com" + - "https://m-prod-voice2rx-batch.s3.ap-south-1.amazonaws.com" + - "https://m-prod-ekascribe-batch.s3.amazonaws.com" + staging: + type: object + properties: + urls: + type: array + items: + type: string + example: ["*.dev.eka.care"] + s3_buckets: + type: array + items: + type: string + example: + - "https://m-dev-voice-record.s3.ap-south-1.amazonaws.com" + - "https://m-dev-voice2rx-batch.s3.ap-south-1.amazonaws.com" diff --git a/api-reference/health-ai/ekascribe/ip-whitelisting-for-clients.mdx b/api-reference/health-ai/ekascribe/ip-whitelisting-for-clients.mdx deleted file mode 100644 index 2e912e5..0000000 --- a/api-reference/health-ai/ekascribe/ip-whitelisting-for-clients.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: IP Whitelisting for Clients -description: Whitelisting and endpoint information for Eka Scribe APIs & Audio transcription ---- - -# IP Whitelisting & Endpoint Information - -## Production -- **Allowed URLs:** - - `*.eka.care` -- **Allowed IPs:** - - 13.127.159.148/32 - - 52.66.111.19/32 - - 15.206.223.155/32 - - 3.6.124.126/32 - -## Staging -- **Allowed URLs:** - - `*.dev.eka.care` -- **Allowed IPs:** - - 3.6.115.57/32 - - 13.204.33.30/32 - - 43.204.151.111/32 - -## S3 Bucket URLs - -### Production -``` -https://m-prod-voice-record.s3.ap-south-1.amazonaws.com -https://m-prod-voice2rx-batch.s3.ap-south-1.amazonaws.com -https://m-prod-ekascribe-batch.s3.amazonaws.com -``` - -### Staging -``` -https://m-dev-voice-record.s3.ap-south-1.amazonaws.com -https://m-dev-voice2rx-batch.s3.ap-south-1.amazonaws.com -``` - ---- - -> Ensure your network/firewall is configured to allow outbound connections to the above IPs and URLs for seamless integration with Eka Scribe & audio transcription APIs. diff --git a/api-reference/health-ai/ekascribe/ip-whitelisting-for-clients.yaml b/api-reference/health-ai/ekascribe/ip-whitelisting-for-clients.yaml deleted file mode 100644 index 146df3d..0000000 --- a/api-reference/health-ai/ekascribe/ip-whitelisting-for-clients.yaml +++ /dev/null @@ -1,25 +0,0 @@ -# Whitelisting and Endpoint Information for Eka Care Audio Transcription - -whitelisting: - production: - urls: - - "*.eka.care" - ips: - - 13.127.159.148/32 - - 52.66.111.19/32 - - 15.206.223.155/32 - - 3.6.124.126/32 - staging: - urls: - - "*.dev.eka.care" - ips: - - 3.6.115.57/32 - - 13.204.33.30/32 - - 43.204.151.111/32 -s3_buckets: - production: - - https://m-prod-voice-record.s3.ap-south-1.amazonaws.com - - https://m-prod-voice2rx-batch.s3.ap-south-1.amazonaws.com - staging: - - https://m-dev-voice-record.s3.ap-south-1.amazonaws.com - - https://m-dev-voice2rx-batch.s3.ap-south-1.amazonaws.com diff --git a/docs.json b/docs.json index 8007864..ecddb55 100644 --- a/docs.json +++ b/docs.json @@ -152,7 +152,13 @@ }, "api-reference/health-ai/ekascribe/audio-transcription", "api-reference/health-ai/ekascribe/Eka-FHIR-structure", - "api-reference/health-ai/ekascribe/ip-whitelisting-for-clients" + { + "group": "IP Allowlisting", + "icon": "list-check", + "pages": [ + "api-reference/health-ai/ekascribe/ip-allowlisting-for-clients" + ] + } ] }, { @@ -371,6 +377,13 @@ ] } ] + }, + { + "group": "IP Allowlisting", + "icon": "list-check", + "pages": [ + "api-reference/doc-tool/ip-allowlisting-for-clients" + ] } ] },