BCDA-7414: Update Build documentation to reference environments (#198)

## 🎫 Ticket https://jira.cms.gov/browse/BCDA-7414 ## 🛠 Changes Remove v2 alert, change base64 encryption to "encoding," and reference environments + ip allow list on build page. ## ℹ️ Context for reviewers The google group gets lots of questions about not receiving responses from the production url before setting up the allow list and credentials. This should help. ## ✅ Acceptance Validation Manual verification via inspection. ![image](https://github.com/CMSgov/bcda-static-site/assets/120701369/038bb5bd-c47b-4ffc-b4a3-b2e524463fce) ![image](https://github.com/CMSgov/bcda-static-site/assets/120701369/48effc80-7e12-4b6f-a8f0-f58aba9eafa3) ## 🔒 Security Implications - [ ] This PR adds a new software dependency or dependencies. - [ ] This PR modifies or invalidates one or more of our security controls. - [ ] This PR stores or transmits data that was not stored or transmitted before. - [ ] This PR requires additional review of its security implications for other reasons. If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.
CMSgov · May 1, 2024 · f6b3e15 · f6b3e15
1 parent ac40ae4
commit f6b3e15
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 42 deletions.
diff --git a/_includes/build/access_token.html b/_includes/build/access_token.html
@@ -33,14 +33,14 @@ <h4>
 	Access Token cURL Command
 </h4>
 	<p>
-		cURL Option 1: This cURL command requires separate base-64 encryption. We have concatenated the base64 encoding of the ‘Client ID : Secret’ as the argument to the -H flag. Please note that the URL in the Production environment will be different. 
+		cURL Option 1: This cURL command requires separate Base64 encoding. We have concatenated the Base64 encoding of the ‘Client ID : Secret’ as the argument to the -H flag. Please note that the URL in the Production environment will be different. 
 	</p>
 <pre><code>curl -d "" -X POST "https://sandbox.bcda.cms.gov/auth/token" \
 	-H "accept: application/json" \
 	-H "authorization: Basic MjQ2MmM5NmItNjQyNy00ZWZiLWFlZDctMTE4ZTIwYzJlOTk3OjhlODdmMGViYzUwZDEwZjFiYzk3MzQzMjlhOTkwMDE3OWI4NGNjZDM5ZTRkMDkyMGI5MDVjYzM1OWNmNmU5NGE2ZTc2MGJiZTNhMDg5MGM3"</code></pre>
 
 <p>
-	cURL Option 2: This cURL command encrypts your credentials with base-64 encryption
+	cURL Option 2: This cURL command encodes your credentials into Base64.
 </p>
 
 <pre><code>curl -d "" -X POST "https://sandbox.bcda.cms.gov/auth/token" \
@@ -67,7 +67,7 @@ <h4>
 <h4>
 	Access Token Explanation
 </h4>
-<p>In cURL Option 1, you must base-64 encode the Client ID and Secret. Once that is performed, the encoded credentials can be passed to cURL as a header with the form: authorization: Basic [base64-encoded clientId:secret]</p>
+<p>In cURL Option 1, you must base-64 encode the Client ID and Secret. Once that is performed, the encoded credentials can be passed to cURL as a header with the form: authorization: Basic [Base64-encoded clientId:secret]</p>
 <p>In cURL Option 2, the user can take advantage of cURL’s built-in ability to base-64 encode the clientId and secret, and request and receive their token in a single step.
 If your operation succeeds, you will receive a 202 response with your access token as a header. You will receive a 401 Unauthorized response if your credentials are invalid or if your token has expired. No additional information is returned with a 401 response. When you receive a 401 response for a token you were just using successfully, you should request a new access token as outlined above.</p>
 

diff --git a/_includes/build/bcda_credentials.html b/_includes/build/bcda_credentials.html
@@ -16,5 +16,7 @@ <h3>
 </h3>
 
 <p>
-	Representatives of Shared Savings Program (SSP) ACOs can generate BCDA credentials by logging into their <a href="https://acoms.cms.gov/" target="_blank" rel="noopener" class="in-text__link">ACO-MS portal</a> accounts and navigating to the ACO-MS Knowledge Library. Representatives of REACH ACOs and DCEs, KCEs, and KCF Entities can do the same by logging into their 4i account and navigate to the 4i Knowledge Library.
+ <p><u>ACOs in the Medicare Shared Savings Program:</u> Create and manage your organization's BCDA credentials from the <a href="https://acoms.cms.gov/" rel="noopener">ACO Management System</a>.</p> 
+<p><u>REACH ACOs and KCEs or KCFs in the Kidney Care Choices Model:</u> Create and manage your organization's BCDA credentials from the <a href="https://4innovation.cms.gov/landing" rel="noopener">4i portal</a>.</p>
+<p>When creating new credentials, be prepared to provide the IP address(es) for each system that will make requests to BCDA. It may take up to an hour for the allow list to be updated after the IP address(es) are added.</p>
 </p>
diff --git a/_includes/build/bcda_user_guide.html b/_includes/build/bcda_user_guide.html
@@ -1,3 +1,4 @@
 <p>
 For each request and operation, we provide example requests and example cURL commands. We will highlight any common errors or unique attributes of our API. Lastly, we provide an example response from the API.
+<p>This documentation is for the production environment (api.bcda.cms.gov). To access this API, your organization must <a href="#authorization">obtain production credentials</a> and add its IP address. If you do not have credentials, you can access synthetic data using the sandbox environment (sandbox.bcda.cms.gov). After adding IP addresses to 4i / ACO-MS, it may take up to an hour for the IPs to be added to the allow list.</p>
 </p>
diff --git a/_includes/guide/production_environment.html b/_includes/guide/production_environment.html
@@ -1,8 +1,10 @@
 <p>
-	In order to obtain your organization’s claims data in the production environment, you must have obtained API credentials from either the ACO-MS system for Shared Savings Program ACOs or from 4i for REACH ACOs, and DCEs, KCEs, and KCF Entities. Every request demands a bearer token which can only be obtained with active BCDA credentials.
+	In order to obtain your organization's claims data in the production environment, you must have obtained BCDA credentials from either the ACO Management System or the 4i portal. Every request demands a bearer token which can only be obtained with active BCDA credentials.
 </p>
 <p>
-	Representatives of Shared Savings Program (SSP) ACOs can generate BCDA credentials by logging into their <a href="https://acoms.cms.gov" target="_blank" rel="noopener" class="in-text__link">ACO-MS portal</a> accounts and navigating to the ACO-MS Knowledge Library. REACH ACOs and DCEs, KCEs, and KCF Entities can do the same by logging into their  <a href="https://4innovation.cms.gov/landing" target="_blank" rel="noopener" class="in-text__link">4i account</a> and navigate to the 4i Knowledge Library.
+	<p><u>ACOs in the Medicare Shared Savings Program:</u> Create and manage your organization's BCDA credentials from the <a href="https://acoms.cms.gov/" rel="noopener">ACO Management System</a>.</p> 
+   <p><u>REACH ACOs and KCEs or KCFs in the Kidney Care Choices Model:</u> Create and manage your organization's BCDA credentials from the <a href="https://4innovation.cms.gov/landing" rel="noopener">4i portal</a>.</p>
+   <p>When creating new credentials, be prepared to provide the IP address(es) for each system that will make requests to BCDA. It may take up to an hour for the allow list to be updated after the IP address(es) are added.</p>
 </p>
 <p>
 	Reminder: Before you generate BCDA credentials, please <a href="#try-the-api" class="in-text__link">try out the BCDA Sandbox experience</a>.

diff --git a/build.html b/build.html
@@ -23,15 +23,6 @@
           </a>
         </li>
 
-
-        <li class="ds-c-vertical-nav__item">
-          <a class="ds-c-vertical-nav__label" href="#bcda-v2">
-            BCDA Version 2 (V2)
-          </a>
-        </li>
-
-
-
         <li class="ds-c-vertical-nav__item">
           <a class="ds-c-vertical-nav__label ds-c-vertical-nav__label" href="#request-metadata">
             Request Metadata
@@ -136,18 +127,6 @@
 
     <main id="main" class="ds-l-md-col--8 ds-l-lg-col--9">
       <div class="guide-content">
-        <div class="ds-c-alert ds-c-alert--hide-icon" id="version-2-header-alert">
-          <div class="ds-c-alert__body">
-            <p class="ds-c-alert__text">
-              <box>
-                Version 2 of the Beneficiary Claims Data API (BCDA V2) endpoints are available as of Summer 2021.
-                If you are interested in interacting with BCDA V2 endpoints, 
-                please navigate to the <a href="/build.html#bcda-v2" class="in-text__link"><em>BCDA Version 2 (V2)</em></a> section for more information.
-              </box>
-
-            </p>
-          </div>
-        </div>
         <div id="bcda-user-guide">
           <h1>
             BCDA User Guide Documentation
@@ -156,21 +135,7 @@ <h1>
             {% include build/bcda_user_guide.html %}
           </div>
         </div>
-        <div id="bcda-v2">
-          <h1>
-            BCDA Version 2 (V2)
-          </h1>
-          <div class="ds-c-alert ds-c-alert--hide-icon" id="version-2-alert">
-            <div class="ds-c-alert__body">
-              <p class="ds-c-alert__text">
-                Version 2 of the Beneficiary Claims Data API (BCDA V2) is now available as of Summer 2021. 
-              </p>
-            </div>
-          </div>
-          <div class="ds-u-font-size--base">
-            {% include build/bcda_v2.html %}
-          </div>
-        </div>
+
         <div id="request-metadata">
           <h1>
             Request Metadata