Getting Started

Welcome to our API Developer Portal. This portal serves as the central location to explore, understand, and test the APIs managed by our teams. This guide will help you quickly find and consume the APIs you need.

Authentication

All APIs are protected using predefined client_id and client_secret credentials.

Example Request:

GET https://api.mscloud.usf.edu/<api-name>/endpoint

Headers: 
client_id: <your-client-id>
client_secret: <your-client-secret>

If the credentials are missing or incorrect, the API will return 401 Unauthorized response.

Note: These credentials are provided to your team directly. If you don’t have them, please contact your internal API owner.

How to Get Client ID and Secret

To access our APIs, you'll need a client_id and client_secret pair. Follow these steps to request your credentials:

Request Process

Open a Service Ticket in JIRA with the following details:

  • Project: Service Desk

  • Work Type: Service Request

  • Request Type: Request Service

  • Summary: Generate clientid and secret for developer portal

  • Description: Include the name of the API you need client ID and secret for (e.g., ux-appian-student)

  • Service Team: Integrations (This is important)

What to Include

In your ticket description, make sure to specify:

  • The exact name of the API you want to access

  • Your intended use case (optional but helpful)

Processing Time

Once submitted, the Integrations team will review your request and provide your client ID and secret credentials.

Need Help?

If you have questions about the request process or need assistance with your JIRA ticket, please contact the Integrations team directly.

API Structure

APIs are grouped into Products, each representing a set of related APIs owned by a business function or technical team.

API Grouping by Products

APIs are grouped into Products based on business domains:

Group

Description

Integrated Systems

APIS

Student APIs

APIs for managing student information, academic records, admissions processes, and educational services. Includes student data management, batch processing, departmental services, and document handling for educational institutions.

Banner, BannerHealth, DegreeWorks, Dynamics, AppEnhancer

cai-bz-edu-student, cai-bz-edu-student-batch, cai-sys-student-cdc-polls, cai-sys-students-m4, cai-ux-appian-student, cai-ux-student, cai-bz-bpm, cai-sys-admissions-vendor-files, cai-sys-bpm, cai-sys-depts, cai-sys-documents, cai-sys-dynamics-hubspot, cai-sys-dynamics365, cai-sys-eai, cai-sys-text, cai-ux-dynamics365

Travel APIs

APIs for travel management including booking, expense tracking, and travel-related administrative functions. Provides financial management capabilities and foundational services for travel operations.

FAST

cai-bz-admin-travel, cai-ux-appian-travel, cai-sys-fm, cai-sys-fm-db, cai-ux-foundation

Employee APIs

APIs for employee management and human resources operations. Handles employee data, administrative functions, and HR-related workflows within the organization.

Oracle HCM

cai-bz-admin-employee, cai-ux-appian-employee

Identity APIs

APIs for user authentication, authorization, and identity management services. Provides secure access control and identity verification across organizational systems.

UIDDB

iam-bz-admin-identity-v2, iam-sys-identity

ID Card APIs

APIs for ID card lifecycle management including creation, printing, archival, and identity verification services. Supports physical and digital ID card operations.

IDCARDDB, BACS

ot-bz-idcard, ot-sys-idcard, ot-ux-idcard, ot-ux-idcard-archivum, ot-ux-identity-idcard

CDC APIs

APIs for change data capture and real-time data polling services. Provides mechanisms to track and respond to data changes across systems with configurable polling intervals.

Banner, UIDDB

cai-sys-cdc-polls, cai-sys-cdc-polls-5m

Other APIs

APIs for general business operations including campaigns, facilities management, billing, SCADA systems, and support services. Encompasses various operational and administrative functions.

Twilio and more

cai-bz-admin-campaign, cai-sys-redis-cache, ot-bz-adm-facilities, ot-bz-billing, ot-bz-scada, ot-sys-scada, ot-sys-spaces, ot-ux-imageservice, ot-ux-insight, ot-ux-spaces

To browse all APIs by product, go to the Products section

Disclaimer: This documentation reflects the information available at the time of creation and will be continuously improved and updated. If you have suggestions or feedback regarding any of the API groupings, descriptions, or integrated systems listed above, please let us know.

How to Search for API Endpoints

Follow these steps to find specific API endpoints in the developer portal:

  1. Identify the Product Category

    Determine which product your desired endpoint likely belongs to. For example, if you're looking for test score data, it would fall under the Student product category.

  2. Navigate to the Product Page

    Go to the specific product page (e.g., Student) then click on the product to view all related APIs.

  3. Understand API Naming Conventions

    • Client-facing APIs: Start with ux (recommended starting point)

    • Internal APIs: Start with bz or sys

  4. Browse Client-Facing APIs First

    Start with APIs that begin with ux, such as:

    • ux-foundation

    • ux-student

    • ux-appian-student

  5. Explore API Endpoints

    • Click on each API to view its available endpoints.

    • Alternative: If you know the API name, go directly to the APIs page and filter by that specific API name.

  6. Use Keyword Search

    • Once inside an API, use the keyword search box.

    • Enter relevant terms (e.g., "testscores") to find matching endpoints.

    • Note: The keyword must be present in the actual endpoint name or path for filtering to work.

  7. If No Results in Client-Facing APIs

    • Try internal APIs that start with bz or sys.

    • Follow the same search process for these APIs.

  8. Still No Results?

    Contact the EAI team for additional support and guidance.

    Tip: Always start with ux APIs as they are designed for client-facing applications and are most likely to contain the endpoints you're looking for. Remember that search filtering only works when your keyword appears directly in the endpoint name or path.

Using the API Console

The Developer Portal includes a built-in Test Console where you can try out APIs before integrating them into your applications.

How to use it:

  1. Sign in to the Developer Portal (if required)

  2. Navigate to the APIs section

  3. Select the desired API and endpoint

  4. Use the Test tab to make real API calls

  5. Enter your client_id and client_secret in the request headers

This is especially helpful for:

  • Understanding request/response formats

  • Testing edge cases

  • Validating integration points before development

Documentation

Each API includes:

  • Request and response schemas

  • Sample payloads

  • Error messages and status codes

  • Usage tips and business context

You can view this information directly within each API's page in the Developer Portal.

Support & Contact

For help with credentials, API access, or technical issues, contact the API support team:

Email: eai@usf.edu