BCDA-7973: Add loading for Try The API creds (#196)

Add "dynamic" loading for Try The API code snippets. Puts test credentials into YML file which can be used for the rest of the codebase or other credentials. ## 🎫 Ticket https://jira.cms.gov/browse/BCDA-7973 ## 🛠 Changes (What was added, updated, or removed in this PR.) Added YML file to hold sandbox clients and secrets. Updated existing usages of hard-coded clients and secrets to pull from YML file. ## ℹ️ Context for reviewers N/A ## ✅ Acceptance Validation Viewed changes within local environment. <img width="778" alt="Screenshot 2024-04-18 at 3 56 26 PM" src="https://github.com/CMSgov/bcda-static-site/assets/162146803/dfb29be3-f42a-40f8-a1cd-fc7996e93e8e"> <img width="762" alt="Screenshot 2024-04-18 at 3 56 36 PM" src="https://github.com/CMSgov/bcda-static-site/assets/162146803/f60cc007-d68b-4e58-a8d4-3604f703e631"> <img width="805" alt="Screenshot 2024-04-18 at 3 56 47 PM" src="https://github.com/CMSgov/bcda-static-site/assets/162146803/a9632cdf-ecd5-4993-a4a2-296fc5561d1e"> <img width="801" alt="Screenshot 2024-04-18 at 3 57 00 PM" src="https://github.com/CMSgov/bcda-static-site/assets/162146803/9da22fb0-21cd-4636-8a06-e5c64c9d869e"> <img width="762" alt="Screenshot 2024-04-18 at 3 57 11 PM" src="https://github.com/CMSgov/bcda-static-site/assets/162146803/a0099c18-0247-4003-ada8-f16e9c8a9ac5"> ## 🔒 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 · Apr 18, 2024 · ff85aab · ff85aab
1 parent df1e294
commit ff85aab
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 20 deletions.
diff --git a/_data/credentials.yml b/_data/credentials.yml
@@ -0,0 +1,30 @@
+sandbox:
+  extra_small:
+    client_id: "3841c594-a8c0-41e5-98cc-38bb45360d3c"
+    client_secret: "efef20edc106b7b355ff09754d5b19014f42820996629a469aa3d4ce1063cbd098b08ccba3bbdcbf"
+  small:
+    client_id: "d5f83f74-6c55-4f1e-9d16-0022688171ba"
+    client_secret: "e7a56d9e54dadaae1c0effde59ae1c804088cb4287f7f9fd5de6de0e3399923a59b5ad37a38dab7a"
+  medium:
+    client_id: "8c75a6f6-02b9-4a47-96c1-0bd6efd4b5e3"
+    client_secret: "283e10b42cfb7de88bdf7ebd5d4f178ba6af19b6eadfbc36675754a1576c899435bb098dd97aa8b0"
+  large:
+    client_id: "f268a8c6-8a29-4d2b-8b92-263dc775750d"
+    client_secret: "1087acf26be69e26d4ab5f8078d63cb737f3dd9aeedb928c463dd72d7b111191de16b484428d8d8f"
+  extra_large:
+    client_id: "6152afb4-c555-46e4-93de-fa16a441d643"
+    client_secret: "7c312fbe1fafaf4fab3e4a71c20bb79106a083a24784ef83dc56a2b1f891a9f52b181a20eec698a0"
+adv:
+  small:
+    client_id: "6dc59a4c-ef93-46c0-9c00-02e500e13731"
+    client_secret: "317a7e3d11d617931ef9c39a2e5c34747f4349cde2b3ec7355f5b01d6c8e19aefca45483966e5f63"
+  large:
+    client_id: "69b1ecae-750a-479b-9997-eb38b1197adb"
+    client_secret: "3611796c42ee5ee92fae59b66c50f48ab0e40f2bc331e9429d7b10413f232b0477939a9aa6148748"
+enhancement:
+  small:
+    client_id: "d6975f99-d83e-4eee-9a54-c057be12d1ff"
+    client_secret: "56b4057a56d0c83657757e97aef63f4f163d64caad2950cd324ed346dbeffa1ed02a6a3d4d92b116"
+  large:
+    client_id: "1f4575c9-80ea-425c-9d3e-c2b79e9159da"
+    client_secret: "10d824c77f7f00aad9c8cab420244f1008ec08d68eb194818c01e504586db84c6184ea89079cdeef"
diff --git a/_includes/guide/adv_credentials.html b/_includes/guide/adv_credentials.html
@@ -2,14 +2,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    6dc59a4c-ef93-46c0-9c00-02e500e13731
+    {{site.data.credentials.adv.small.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Small Advanced ACO (100 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    317a7e3d11d617931ef9c39a2e5c34747f4349cde2b3ec7355f5b01d6c8e19aefca45483966e5f63
+    {{site.data.credentials.adv.small.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Small Advanced ACO (100 synthetic beneficiaries)' type='Client Secret' %}
@@ -19,14 +19,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    69b1ecae-750a-479b-9997-eb38b1197adb
+    {{site.data.credentials.adv.large.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Large Advanced ACO (10,000 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    3611796c42ee5ee92fae59b66c50f48ab0e40f2bc331e9429d7b10413f232b0477939a9aa6148748
+    {{site.data.credentials.adv.large.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Large Advanced ACO (10,000 synthetic beneficiaries)' type='Client Secret' %}

diff --git a/_includes/guide/bcda_enhancement_credentials.html b/_includes/guide/bcda_enhancement_credentials.html
@@ -2,14 +2,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    d6975f99-d83e-4eee-9a54-c057be12d1ff
+    {{site.data.credentials.enhancement.small.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Small REACH ACO (100 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    56b4057a56d0c83657757e97aef63f4f163d64caad2950cd324ed346dbeffa1ed02a6a3d4d92b116
+    {{site.data.credentials.enhancement.small.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Small REACH ACO (100 synthetic beneficiaries)' type='Client Secret' %}
@@ -19,14 +19,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    1f4575c9-80ea-425c-9d3e-c2b79e9159da
+    {{site.data.credentials.enhancement.large.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Large DCE (10,000 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    10d824c77f7f00aad9c8cab420244f1008ec08d68eb194818c01e504586db84c6184ea89079cdeef
+    {{site.data.credentials.enhancement.large.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Large DCE (10,000 synthetic beneficiaries)' type='Client Secret' %}

diff --git a/_includes/guide/credentials.html b/_includes/guide/credentials.html
@@ -2,14 +2,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    3841c594-a8c0-41e5-98cc-38bb45360d3c
+    {{site.data.credentials.sandbox.extra_small.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Extra-Small ACO (50 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    efef20edc106b7b355ff09754d5b19014f42820996629a469aa3d4ce1063cbd098b08ccba3bbdcbf
+    {{site.data.credentials.sandbox.extra_small.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Extra-Small ACO (50 synthetic beneficiaries)' type='Client Secret' %}
@@ -19,14 +19,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    d5f83f74-6c55-4f1e-9d16-0022688171ba
+    {{site.data.credentials.sandbox.small.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Small ACO (2,500 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    e7a56d9e54dadaae1c0effde59ae1c804088cb4287f7f9fd5de6de0e3399923a59b5ad37a38dab7a
+    {{site.data.credentials.sandbox.small.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Small ACO (2,500 synthetic beneficiaries)' type='Client Secret' %}
@@ -36,14 +36,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    8c75a6f6-02b9-4a47-96c1-0bd6efd4b5e3
+    {{site.data.credentials.sandbox.medium.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Medium ACO (7,500 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    283e10b42cfb7de88bdf7ebd5d4f178ba6af19b6eadfbc36675754a1576c899435bb098dd97aa8b0
+    {{site.data.credentials.sandbox.medium.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Medium ACO (7,500 synthetic beneficiaries)' type='Client Secret' %}
@@ -53,14 +53,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    f268a8c6-8a29-4d2b-8b92-263dc775750d
+    {{site.data.credentials.sandbox.large.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Large ACO (20,000 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    1087acf26be69e26d4ab5f8078d63cb737f3dd9aeedb928c463dd72d7b111191de16b484428d8d8f
+    {{site.data.credentials.sandbox.large.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Large ACO (20,000 synthetic beneficiaries)' type='Client Secret' %}
@@ -70,14 +70,14 @@
 <div class="acc_content">
     Client ID:
     {%- capture client_id -%}
-    6152afb4-c555-46e4-93de-fa16a441d643
+    {{site.data.credentials.sandbox.extra_large.client_id}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_id aco='Extra-Large ACO (30,000 synthetic beneficiaries)' type='Client ID' %}
 
     Client Secret:
     {%- capture client_secret -%}
-    7c312fbe1fafaf4fab3e4a71c20bb79106a083a24784ef83dc56a2b1f891a9f52b181a20eec698a0
+    {{site.data.credentials.sandbox.extra_large.client_secret}}
     {%- endcapture -%}
 
     {% include copy_snippet.md code=client_secret aco='Extra-Large ACO (30,000 synthetic beneficiaries)' type='Client Secret' %}

diff --git a/_includes/guide/try_the_api.html b/_includes/guide/try_the_api.html
@@ -65,7 +65,7 @@ <h2>
 </h2>
 <p>
 	For this demonstration, we will provide sample API credentials to the sandbox environment. We will be using the sample
-	credentials for an Extra-Small Model Entity (25 beneficiaries). Feel free to follow along with any of the sample credentials.
+	credentials for an Extra-Small Model Entity (50 beneficiaries). Feel free to follow along with any of the sample credentials.
 </p>
 <p>
 	Our credentials come in two pieces: a Client ID and a Client Secret. We will submit these two pieces to the API. Notice that the credentials are included in one of the headers (--user). You must use this format: --user {insert client id}{insert colon}{insert client secret}.
@@ -74,7 +74,7 @@ <h3>
 	Sample cURL Command to Submit Credentials for an Access Token
 </h3>
 <pre><code>curl -d "" -X POST "https://sandbox.bcda.cms.gov/auth/token" \
-	--user 2462c96b-6427-4efb-aed7-118e20c2e997:8e87f0ebc50d10f1bc9734329a9900179b84ccd39e4d0920b905cc359cf6e94a6e760bbe3a0890c7 \
+	--user {{site.data.credentials.extra_small.client_id}}:{{site.data.credentials.extra_small.client_secret}} \
 	-H "accept: application/json"</code></pre>
 
 <h3>