Skip to content

Commit

Permalink
Update postman.zip link (#66)
Browse files Browse the repository at this point in the history
* Update postman.zip

* Fixes to url
  • Loading branch information
lgarceau768 authored Aug 31, 2022
1 parent cd0a8d0 commit 9ce0ac9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Binary file modified assets/downloads/postman.zip
Binary file not shown.
4 changes: 2 additions & 2 deletions postman/CMS_DPC_API_Developer.postman_collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"info": {
"_postman_id": "3aefd688-7b7d-405e-9c87-586b897bd58b",
"name": "Centers for Medicare & Medicaid Services (CMS) - Data at the Point of Care (DPC) API - App Developer",
"description": "This collection contains example requests for the public endpoints for the Data at the Point of Care (DPC) API. In order to use it, you must first create public and private keys and update the following values in your local Postman sandbox environment:\n\n1) `client_token`: This is sometimes also referred to as a `macaroon` and can be created on the DPC portal. Be sure to save a copy of your token in a safe place.\n\n2) `PRIVATE_KEY`: Follow the steps found here to create public and private keys: https://dpc.cms.gov/docs#upload-your-first-public-key and paste the contents of your private key in the `PRIVATE_KEY` field of your local Postman sandbox environment. Do not share your private key otherwise.\n\n3) `key-id`: This is the system id of your public key, which is returned to you when the public key is uploaded to the DPC portal. You need this to generate a JWT, which you will exchange for an access token.\n\nWith these 3 values in place, the JWT and a fresh access token are automatically generated for you before each request in this Postman collection to prevent you from having to manually refresh the access token every 5 minutes while using the collection. Note that, due to the way Postman works, you may occasionally experience a race condition that results in your access token not being refreshed before the main Postman request. In this case, you would receive a 401 with a message about invalid credentials. If this happens, just try the request again, and you should have a fresh token the second time.\n\nUnder `Security/Authentication`, in the `Public Keys`, you will find a request to add a public key to DPC without using the portal. This request requires auth and is not required in order to use the other requests in this collection. If you would like to create a new public key, first generate the keys locally, then follow the directions in the `Add/Register Public Key on DPC Sandbox` description. You do not need to update the `PUBLIC_KEY`, `public-key-label`, and `public-key-signature` values in the environment otherwise.\n",
"description": "This collection contains example requests for the public endpoints for the Data at the Point of Care (DPC) API. In order to use it, you must first create public and private keys and update the following values in your local Postman sandbox environment:\n\n1) `client_token`: This is sometimes also referred to as a `macaroon` and can be created on the DPC portal. Be sure to save a copy of your token in a safe place.\n\n2) `PRIVATE_KEY`: Follow the steps found here to create public and private keys: https://dpc.cms.gov/docsV1#upload-your-first-public-key and paste the contents of your private key in the `PRIVATE_KEY` field of your local Postman sandbox environment. Do not share your private key otherwise.\n\n3) `key-id`: This is the system id of your public key, which is returned to you when the public key is uploaded to the DPC portal. You need this to generate a JWT, which you will exchange for an access token.\n\nWith these 3 values in place, the JWT and a fresh access token are automatically generated for you before each request in this Postman collection to prevent you from having to manually refresh the access token every 5 minutes while using the collection. Note that, due to the way Postman works, you may occasionally experience a race condition that results in your access token not being refreshed before the main Postman request. In this case, you would receive a 401 with a message about invalid credentials. If this happens, just try the request again, and you should have a fresh token the second time.\n\nUnder `Security/Authentication`, in the `Public Keys`, you will find a request to add a public key to DPC without using the portal. This request requires auth and is not required in order to use the other requests in this collection. If you would like to create a new public key, first generate the keys locally, then follow the directions in the `Add/Register Public Key on DPC Sandbox` description. You do not need to update the `PUBLIC_KEY`, `public-key-label`, and `public-key-signature` values in the environment otherwise.\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
Expand Down Expand Up @@ -138,7 +138,7 @@
}
]
},
"description": "This endpoint registers the provided public key with the organization.\n\nThe provided key MUST be PEM encoded. (See https://dpc.cms.gov/docs#upload-your-first-public-key) RSA keys of 4096-bits or greater are supported, as well as ECC keys using one of the following curves:- secp256r1- secp384r1\n\nPREREQUISITES:\n- `PUBLIC_KEY`: Before using this endpoint, you must paste your PEM encoded public key as the value for this environment variable.\n- `public_key_signature`: Before using this endpoint, you must paste your public key signature as the value for this environment variable.\n- `public-key-label`: Feel free to modify this label, which is `Test Public Key` by default."
"description": "This endpoint registers the provided public key with the organization.\n\nThe provided key MUST be PEM encoded. (See https://dpc.cms.gov/docsV1#upload-your-first-public-key) RSA keys of 4096-bits or greater are supported, as well as ECC keys using one of the following curves:- secp256r1- secp384r1\n\nPREREQUISITES:\n- `PUBLIC_KEY`: Before using this endpoint, you must paste your PEM encoded public key as the value for this environment variable.\n- `public_key_signature`: Before using this endpoint, you must paste your public key signature as the value for this environment variable.\n- `public-key-label`: Feel free to modify this label, which is `Test Public Key` by default."
},
"response": []
},
Expand Down

0 comments on commit 9ce0ac9

Please sign in to comment.