0% found this document useful (0 votes)
25 views8 pages

API Documentation For AICERTs 3

This document serves as the API documentation for AICERTs, detailing endpoints for retrieving certificate details and badge images. The API is open and does not require authentication, with specific endpoints provided for accessing certificate information and associated media. Additional notes and contact information for support are also included.

Uploaded by

rajputshavi07
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
25 views8 pages

API Documentation For AICERTs 3

This document serves as the API documentation for AICERTs, detailing endpoints for retrieving certificate details and badge images. The API is open and does not require authentication, with specific endpoints provided for accessing certificate information and associated media. Additional notes and contact information for support are also included.

Uploaded by

rajputshavi07
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 8

API Documentation

for

AICERTs

Version 1.0
Contents
Introduction ................................................................................................................................3

Authentication ............................................................................................................................3

Base URL .................................................................................................................................3

API Endpoints ..............................................................................................................................3

1. Certificate Details Retrieval ..................................................................................................3

2. Certificate Badge Image Retrieval ........................................................................................6

Additional Notes .........................................................................................................................7

Contact Team ..............................................................................................................................7

Version History ............................................................................................................................8

AI Certs 2025 | All Rights Reserved 2


Introduction
This document provides a comprehensive guide to the APIs provided for AICERTs. The APIs
facilitate secure, scalable, and efficient interactions between AICERTs' systems and external
applications.

Authentication
This API is open and does not require authentication or tokens.

Base URL
https://www.aicerts.ai/wp-json/wp/v2/

API Endpoints

1. Certificate Details Retrieval


Endpoint:

GET https://www.aicerts.ai/wp-json/wp/v2/courses/{certificate_id}

Description:

Retrieves details of a specific certificate, including title, course tagline, certificate code, badge,
and associated tools.

Request Parameters:

Parameter Type Description

certificate_id int The ID of the certificate to be retrieved

AI Certs 2025 | All Rights Reserved 3


Response:

"id": 1234,

"title": "AI Certification in Machine Learning",

"acf": {

"certificate_code": "AI-ML-2024",

"duration": "6 months",

"prerequisite": "Basic knowledge of AI and programming",

"certification_module": ["Introduction to AI", "Machine Learning Basics", "Deep Learning


Fundamentals"],

"tools": [

{ "id": 699, "name": "Runway ML" },

{ "id": 701, "name": "TensorFlow" },

{ "id": 703, "name": "PyTorch" }

],

"passing_score": 75,

"number_of_mcqs": 50,

"number_of_examinations": 1,

"exam_objectives": "Assess knowledge on AI, ML, and Deep Learning concepts"

},

"featured_media": 26083

AI Certs 2025 | All Rights Reserved 4


Included Fields: For Reference

 id: Certificate ID

 title: Certificate name

 certificate_code: Unique code for the certificate

 duration: Length of the certification program

 prerequisite: Knowledge or skills required before taking the certification

 certification_module: List of topics covered in the certification

 tools: Names and IDs of tools covered in the certification

 passing_score: Minimum score required to pass the certification

 number_of_mcqs: Total number of multiple-choice questions in the exam

 number_of_examinations: Number of exams required for certification

 exam_objectives: Key learning objectives assessed in the exam

Example Usage:

GET https://www.aicerts.ai/wp-json/wp/v2/courses/1234

To retrieve the corresponding tool name and image, refer to the following tools_data structure:

"tools_data": [

"name": "Runway ML",

"tool_image": "https://www.aicerts.ai/wp-content/uploads/2025/01/image-2-13.jpg"

},

"name": "SciPy",

AI Certs 2025 | All Rights Reserved 5


"tool_image": "https://www.aicerts.ai/wp-content/uploads/2025/01/image-27.png"

},

"name": "AIVA",

"tool_image": "https://www.aicerts.ai/wp-content/uploads/2025/01/image-28.png"

},

"name": "Grammarly",

"tool_image": "https://www.aicerts.ai/wp-content/uploads/2025/01/image-30.jpg"

Note: The above structure allows for easy mapping between tool metadata and its associated
image asset for use in the API documentation or frontend integration.

Example Usage:

GET https://www.aicerts.ai/wp-json/wp/v2

2. Certificate Badge Image Retrieval


Endpoint:

GET https://www.aicerts.ai/wp-json/wp/v2/media/{media_id}

Description:

Retrieves the badge image associated with a certificate.

Request Parameters:

AI Certs 2025 | All Rights Reserved 6


Parameter Type Description

media_id int The ID of the media file (e.g., 26083)

Response:

"id": 26083,

"source_url": "https://www.aicerts.ai/wp-content/uploads/badge-image.png"

Example Usage:

GET https://www.aicerts.ai/wp-json/wp/v2/media/26083

Additional Notes
 The featured_media field contains the media ID, which can be used with the Certificate
Badge Image Retrieval endpoint.

 The tools field is an array of tool IDs, which can be individually retrieved using the
Certificate Tool Retrieval endpoint.

Contact Team
In case of any queries or encountered any issues while working on this platform, please drop an
email to the following distro lists with appropriate screenshots:

 Support Team: [email protected]

AI Certs 2025 | All Rights Reserved 7


Version History
Date Version Author Reviewer Changes
03/18/2025 Version 1.0 Anjali Thakkar Darshil Shah Initial Copy

AI Certs 2025 | All Rights Reserved 8

You might also like