For new users to Connect or those considering becoming Connect customers who want to "look under the hood" at the API and its queries, we recommend Apollo Studio.
While there are many GraphQL clients available, we recommend using Apollo Studio to explore the Connect API. This article provides an overview of how to access and explore the Connect endpoint within Apollo Studio's Sandbox.
Using Apollo Studio to Evaluate the Connect API
Apollo Studio is web-based and for API exploration purposes, does not require you to create an Apollo account. The environment you will review depends on the access provided. If you are unsure which environment you have access to, contact your Noda representative and ask if it is production or pre-prod.
For customers exploring their Noda production site, navigate to https://studio.apollographql.com/sandbox?endpoint=https://api.iotjetstream.com/
For prospective customers exploring the Noda demo site, navigate to https://studio.apollographql.com/sandbox?endpoint=https://api.cloud-preprod.iotjetstream.com/
This will automatically open up the embedded API documentation within the Apollo sandbox where you can run queries, expand the schema, etc. For users who are evaluating Connect for licensing or application development, this will suffice for your needs.
Using Apollo Studio sandbox to interact with the Connect API
For users who wish to utilize the Apollo Studio sandbox to interact more deeply with the Connect API, it is possible to configure your authentication settings to eliminate the need to constantly reauthenticate as you're running queries. This requires a free Apollo Studio account.
Configuring Authentication in Apollo Studio
1. Navigate to Settings
2. Turn on Preflight Scripts and copy this script (if you are not logged in to Apollo Studio, you will see a “sign in” button where the script should go):
function parseJwt(token) {
var base64Url = token.split('.')[1];
var base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/');
var jsonPayload = decodeURIComponent(atob(base64).split('').map(function (c) {
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
}).join(''));
return JSON.parse(jsonPayload);
}
async function getJetstreamTokens() {
const userName = explorer.environment.get('username')
const password = explorer.environment.get('password');
if (!userName || !password) {
throw new Error('Username or Password missing from Studio enviroment variables')
}
const body = {
query: 'query ($username: String!, $password: String!) { authenticate(input: { password: $password, username: $username }) { accessToken\n } }',
variables: { "username": userName, "password": password }
}
const res = await explorer.fetch(
'https://api.cloud.iotjetstream.com/',
{
headers: { 'Content-Type': 'application/json' },
method: 'POST',
body: JSON.stringify(body)
}
).then((response) => {
return response.json();
})
// if response is successful get headers
if (res.data) {
explorer.environment.set('auth_token', res.data.authenticate.accessToken, true);
}
}
const authToken = explorer.environment.get('auth_token')
if (authToken) {
const parsedToken = parseJwt(authToken)
const tokenExpiry = parsedToken.exp
const nowInSeconds = () => Date.now() / 1000;
if (nowInSeconds() >= tokenExpiry) {
await getJetstreamTokens()
}
} else {
await getJetstreamTokens()
}
3. Scroll to Personal Settings to set your Environment Variables including a JSON object for username and password (this is your username and password for Connect/Noda. If you do not have Connect login credentials, contact your Noda representative before proceeding.)
{
"username": "",
"password": ""
}4. Now you need to set shared headers. Back in your workspace, select Headers and then Select shared headers
5. In the pop-up window, Apollo Studio will retrieve the necessary information from the preflight script you already input
Authorization = Bearer {{auth_token}}
NOTE: There is a space between "Bearer" and {{auth_token}}
6. Select save and begin running queries.
For a primer on queries, review this help center article.