You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 86efd4f
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,6 +27,7 @@
27
27
The SDK uses several models to structure the data exchanged between the client and Juno's services. These models represent the input data for API requests and the output data returned by the server.
28
28
29
29
#### Key Models:
30
+
30
31
-**CreateProjectModel**: Defines the structure for creating a new project.
31
32
-**CreateUserModel**: Contains the necessary fields to create a new user (email, name, password).
32
33
-**IssueApiKeyRequest**: Defines the request data for issuing an API key for a project.
@@ -41,6 +42,7 @@ The SDK uses several models to structure the data exchanged between the client a
41
42
The SDK includes API methods for interacting with Juno services. These methods abstract the complexities of making HTTP requests and ensure that data is structured according to Juno's requirements.
42
43
43
44
#### Core APIs:
45
+
44
46
-**AuthApi**: Handles authentication tasks, such as issuing API keys and generating JWT tokens.
45
47
-**EmailApi**: Manages email operations like sending emails and registering domains.
46
48
-**ProjectApi**: Manages project-related tasks, including creating projects and linking users.
@@ -51,30 +53,35 @@ The SDK includes API methods for interacting with Juno services. These methods a
51
53
The Juno SDK provides a set of APIs for managing various services. Each API is built to simplify interactions with specific Juno infrastructure components. Below is an overview of how to use the main APIs.
52
54
53
55
### Authentication
56
+
54
57
The **AuthApi** is used to handle authentication-related tasks, including issuing API keys and generating JWT tokens for secure access to Juno services.
55
58
56
59
-**Issue API Key**: Create a new API key for project access. This is necessary for authenticating requests to other services.
57
60
-**Generate JWT**: Once you have an API key, use it to generate a JWT, which is required to authenticate further API requests.
58
61
59
62
### Project Management
63
+
60
64
The **ProjectApi** is responsible for managing projects within Juno’s infrastructure:
61
65
62
66
-**Create Project**: Define and create a new project using the provided model.
63
67
-**Link User to Project**: Associate a user with a project, allowing them to access or contribute to the project.
64
68
65
69
### User Management
70
+
66
71
The **UserApi** is designed for creating and managing users:
67
72
68
73
-**Create User**: Create a new user by providing necessary details like email, name, and password.
69
74
-**Set User Role**: Update a user's role to control access levels (e.g., ADMIN, SUPERADMIN).
70
75
71
76
### Email Management
77
+
72
78
The **EmailApi** allows you to manage email-related operations, such as registering domains and sending emails. It includes the following functionality:
73
79
74
80
-**Register Domain**: Register a domain to use as the sender of emails.
75
81
-**Send Email**: Send an email through Juno’s email service by specifying the sender, recipient, and content.
76
82
77
83
### General Workflow
84
+
78
85
1.**Authentication**: Start by using the **AuthApi** to issue an API key and generate a JWT token.
79
86
2.**Project and User Management**: Set up projects and link users using **ProjectApi** and **UserApi**.
80
87
3.**Email Operations**: If your project involves email management, use **EmailApi** to register sender domains and send emails.
0 commit comments