Project Registration Guide

Warning

This page is still under active development and is subject to change.

This guide will show you how to register your project with Juno using the Juno API. Once your project is registered, you’ll be able to use Juno's services, like email and file storage.

The Juno Documentation serves as a way to make HTTP requests to Juno without the need for an SDK or CLI. When a new release of Juno is deployed, all documentation will be automatically regenerated to ensure it stays up to date.

Step 1: Provide Your Email to the Infra Team

As an Engineering Manager (EM), you will need to provide your email to the Infra team. It's best to use the same email you use for other BoG services for consistency.

If you need to change your email or if a new EM joins the project, the Infra team is responsible for updating or deleting users as necessary. In such cases, contact the Infra team to ensure proper role and email updates for the new EM or email change.

Step 2: Infra Registers Your Project

After receiving your email, the Infra team will follow the Infra Internal Project Registration Playbook to register your email and project.

Upon success, the Infra team will send you Admin credentials to proceed.

Step 3: Generating API Keys for Your Project

With your new Admin credentials, you’ll need to generate API keys for your project to access all Juno services.

To generate a new API Key:

1. Go to the interactive Juno Documentation.
2. Find the /auth/key POST request.
3. Click on Try it out
4. Enter your credentials and click Execute

Warning

Make sure to store this API key securely and never, ever, expose it.

Step 4: Installing and Configuring the Juno SDK

After generating your API key, follow these steps:

1. Install the Juno SDK: You can install the Juno SDK for your project using the appropriate package manager.

   npm install juno-sdk # for projects using npm
   pnpm add juno-sdk # for projects using pnpm
   yarn add juno-sdk # for projects using yarn
   bun install juno-sdk # for projects using bun

2. Configure the SDK: Provide the API key to the Juno SDK in your project’s configuration to start accessing Juno services.

   const juno = require('juno-sdk');
   juno.init({
     apiKey: <your api key>
   });

Do not store the API key in plain text.

As with all API keys, you should be using some sort of secure method to store project-related credentials, environmental variables being the most common.

Step 5: Testing Your Setup

To use any of Juno’s services, you need to authenticate with your API key.

• If using the SDK, your API key will be automatically handled when initialized.
• If using the interactive docs, you’ll need to add your API key manually:
  1. Click the Authorize button in the top-right corner of the page.

2. Enter your API key and hit Authorize.

You can verify that your project has been correctly registered by sending a test request to one of the Juno services, such as email or file storage, using your newly generated API key. All available endpoints can be found and tested in the Juno Documentation.

Recovering or Resetting API Keys

If you forget your API key, there is currently no frontend interface for retrieving or resetting it. However, you can regenerate an API key at any time. If you forget your API key, you will need to contact the Infra team to have it deleted before generating a new one.

Troubleshooting

If you encounter any issues during project registration or while sending test requests, consider the following steps:

• Check your permissions: Ensure you have the necessary Admin permissions to perform actions on Juno.
• Validate your API key: Double-check that your API key is correct and included in the request headers as Authorization: Bearer your-api-key.
• Check for Errors in Response Body: Review the error messages in the response body for more information on the issue. Common errors include:
  • 400 Bad Request: The request is improperly formed (e.g., missing required fields or incorrect parameters).
  • 401 Unauthorized: The API key is missing, invalid, or does not have the correct permissions.
  • 404 Not Found: The specified resource (e.g., user or project) could not be found.

For a full list of possible error codes and detailed descriptions, please refer to the autogenerated API document or contact the infra team for more information.