V2
Introduction
This document provides technical specifications for the Corporate Learning or Admin B2B, including the APIs, database tables and the mockup.
Overview
The Beta version is an improved version of the alpha version, which revamps the interface and adds several features and functions.
Link
API
On AdminB2B section.
https://swagger.arkd.me/reguler/course/
Repository
https://gitlab.com/arkademi/arkademi-admin-panel-b2b/-/tree/main
Production
https://team.arkademi.com/
Staging
https://admin-b2b-ui-revamp.arkademi-admin-panel-b2b.pages.dev/
Mockup & Flow
Mockup
To see mockup detail, click here.
Flow
Requirements
Actors
| Role | In System | Function |
|---|---|---|
| Admin Corporate | admin_organization | Admin Corporate is the main user role that can access some of the B2B admin panel features, from adding users to courses, adding users to corporate, and monitoring the learning progress of their corporates. |
| Employee | member_organization | Employee is a user managed by the admin. |
| Super Admin | super_admin | This is an admin who can log in to all organizations |
Requirements Detail
Login
Requirement
- Organization ID as another requirement to login
- Able to reset password
API
| Method | API | Function |
|---|---|---|
| POST | https://apicourse2.arkademi.com/api/v1/adminB2B/login | post user login data (organization_code, username, password) |
Home or Dashboard
Requirement
- Displays a summary of data from the status page that is described through numbers
API
| Method | API | Function |
|---|---|---|
| GET | https://apicourse2.arkademi.com/api/v1/adminB2B/dashboard | Get dashboard data of total users in the organization, total users in the course, total enrolled, total learning, total completed, and total expired. |
Team Page
Requirement
- In the table, each role has its own color.
- There is a timestamp of when the member was added to the organization.
- Can add members to more than one account in one process.
- When adding members who do not have an account at arkademi.com, the email will be sent an invitation to register to arkademi.com.
- Adding columns with REGISTERED/UNREGISTERED contents to the table
- Change the writing in the ADD EMPLOYEE modal from "Employee Email on Arkademi" to "Employee Email".
API
| Method | API | Function | Detail |
|---|---|---|---|
| GET | https://apicourse2.arkademi.com/api/v1/adminB2B/users | Get the team in organization data | |
| POST | https://apicourse2.arkademi.com/api/v1/adminB2B/takeOutUser | Delete organization members | handleClick, triggering action after to get user data, after delete |
| POST | https://apicourse2.arkademi.com/api/v1/adminB2B/add-user | Add new members to the organization |
Course Page
Requirement
- View the course list
- Register one or more members in a course
- Search by course name
API
| Method | API | Function |
|---|---|---|
| GET | https://apicourse2.arkademi.com/api/v1/adminB2B/users | Get user data to enroll users into courses |
| GET | https://apicourse2.arkademi.com/api/v1/adminB2B/courses | Get the course list |
| POST | https://apicourse2.arkademi.com/api/v1/adminB2B/addUserCourse | Add user to a course |
Status Page
Requirement
- Displays the courses attended by members of the organization and its progress
- Can see certificates that members have successfully obtained.
API
| Method | API | Function |
|---|---|---|
| GET | https://apicourse2.arkademi.com/api/v1/adminB2B/users-progress | Get the list of user status |
Development Environment Requirement
| Development Tools | |
|---|---|
| Versioning | Beta |
| Programming Language | Javascript |
| Framework | React |
Writer: Media
Contributors: Dilla, Chaton, Arif