Skip to content

Update query parameters and add documentation #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brandoncharnesky merged 7 commits into from
Jan 17, 2025
Merged

Update query parameters and add documentation #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c58d9af
Update queryParams in getFromAPI
Jan 10, 2025
23fc388
Extra notes for environment setup
Jan 10, 2025
95a0652
Update dotenv.sample
Jan 10, 2025
4dd66a1
Update dotenv.sample based on review comments
Jan 15, 2025
6ed03e1
Updat quickstart.js with review comments
Jan 15, 2025
4fcd1a4
remove logging
Jan 17, 2025
8671bf9
Cleanup variable
Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion dotenv.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# See README.md for instructions on setting up the .env file
#
RKS_PROJECT_ID=

RKS_SERVICE_ACCOUNT=

# You can use \n to separate the lines in your private key
RKS_PRIVATE_KEY=
RKS_PRIVATE_KEY=
11 changes: 6 additions & 5 deletions quickstart.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,17 @@ async function getServiceAccessToken() {
}


async function getFromApi(serviceAccessToken, resourceUrl, queryParams = {}, raiseError = true) {
async function getFromApi(serviceAccessToken, resourceUrl, queryParams = null, raiseError = true) {

const url = `${baseUrl}${resourceUrl}`
const queryString = queryParams ? `?${new URLSearchParams(queryParams)}` : '';
const url = `${baseUrl}${resourceUrl}${queryString}`;

const response = await fetch(url, {
headers: {
"Authorization": `Bearer ${serviceAccessToken}`,
"Accept": "application/json",
"Content-Type": "application/json; charset=utf-8"
},
queryParams: queryParams,
}
});

if (!response.ok && raiseError) {
Expand Down Expand Up @@ -122,7 +123,7 @@ async function quickstart() {

if (participantIdentifier != "YOUR_PARTICIPANT_IDENTIFIER") {
url = `/api/v1/administration/projects/${rksProjectId}/participants/${participantIdentifier}`;
response = await getFromApi(serviceAccessToken, url, {}, false );
response = await getFromApi(serviceAccessToken, url, null, false );
if (response.status === 404) {
console.log("\nParticipant not found.");
} else {
Expand Down
Loading