Quick start

Get started in 3 easy steps

Objective

Generate a fresh presentation by utilizing a PowerPoint template and JSON data via a request to the PowerPointGeneratorAPI service.

How the API works

Step 1. Create an account

Sign up to PowerPointGeneratorAPI here. Make a note of your email address, password and security key. You will need these to create an authentication token.

Security key will be emailed to you.

Step 2. Create an authentication token

All API calls require authentication. You can create an authentication token manually using the Web Console or programmatically using the POST below.

Create authentication token

POST https://auth.powerpointgeneratorapi.com/v1.0/token/create

This endpoint enables you to create an authentication token. You will need this for all requests to the API. Your authentication token is only valid for 24 hours. Once your token has expired you will need to request a new token.

Headers

Name	Type	Description
Content-Type*	String	multipart/form-data

Request Body

Name	Type	Description
username*	String	your email address
password*	String	your account password
key*	String	your security key

200: OK

400: Bad Request

Example Requests

cURL

curl -d "username=<your_username>&password=<your_password>&key=<your_security_key>" \
     -X POST https://auth.powerpointgeneratorapi.com/v1.0/token/create

Python

import requests

# API endpoint for token creation
url = "https://auth.powerpointgeneratorapi.com/v1.0/token/create"

# Your credentials and security key
credentials = {
    'username': '<your_username>',
    'password': '<your_password>',
    'key': '<your_security_key>'
}

# Headers for the HTTP request
headers = {
    'Content-Type': 'application/x-www-form-urlencoded'
}

# Send a POST request to the API endpoint with credentials
response = requests.post(url, headers=headers, data=credentials)

# Print the response from the API
print(response.text)

JavaScript

// Create a new FormData object to handle the form data
const formData = new FormData();
formData.append("username", "<your_username>");
formData.append("password", "<your_password>");
formData.append("key", "<your_security_key>");

// Define the options for the fetch request
const requestOptions = {
  method: 'POST',
  body: formData,          // Set the body of the request to the FormData object
  redirect: 'follow'       // Specify the redirect behavior
};

// Make a POST request to the authentication endpoint
fetch("https://auth.powerpointgeneratorapi.com/v1.0/token/create", requestOptions)
  .then(response => response.text())    // Parse the response as text
  .then(result => console.log(result)) // Log the result to the console
  .catch(error => console.error('Error:', error)); // Log any errors that occur

Postman

1. Post: https://auth.powerpointgeneratorapi.com/v1.0/token/create

2. Select form-data in the Body tab

3. Populate the KEY and VALUE with your username, password and key

4. Hit Send to get your Token

Step 3: Make a request to PowerPointGeneratorAPI

Download the zip folder below. Using Postman, or some other API client, post the .pptx template file and the JSON data file from the zipped folder to the generator/create endpoint to create your presentation.

507KB

quick-start.zip

archive

Create presentation

POST https://gen.powerpointgeneratorapi.com/v1.0/generator/create

Headers

Name	Type	Description
Content-Type*	String	multipart/form-data
Authorization*	String	Bearer authentication token

Request Body

Name	Type	Description
files*	Object	.pptx template file
jsonData*	String	JSON payload

200

400: Bad Request You can see failure reason in the response message property

{
    // Response
}

401: Unauthorized if your token is not valid you will get this response

{
    // Response
}

Example Requests

cURL

curl --location --request POST 'https://gen.powerpointgeneratorapi.com/v1.0/generator/create' \
-H 'Content-Type: multipart/form-data' \
-H 'Authorization: Bearer <add_your_token_here>' \
-F 'files=@title_slide_template.pptx' \
-F 'jsonData={"presentation":{"template":"title_slide_template.pptx","export_version":"Pptx2010","resultFileName":"quick_start_example","slides":[{"type":"slide","slide_index":0,"shapes":[{"name":"Title 1","content":"Your generated PowerPoint presentation"},{"name":"Subtitle 2","content":"Create,fill and manage PowerPoint documents through simple API requests."}]}]}}'

Python

import requests

payload={'jsonData': '{"template":"title_slide_template.pptx","export_version":"Pptx2010","resultFileName":"quick_start_example","slides":[{"type":"slide","slide_index":0,"shapes":[{"name":"Title 1","content":"Your generated PowerPoint presentation"},{"name":"Subtitle 2","content":"Create, fill and manage PowerPoint documents through simple API requests."}]}]}'}

files=[
  ('files', ('title_slide_template.pptx', open('./title_slide_template.pptx','rb'), 'application/vnd.openxmlformats-officedocument.presentationml.presentation'))
]

response = requests.post(
    'https://gen.powerpointgeneratorapi.com/v1.0/generator/create',
    data=payload,
    files=files,
    headers={
        'Authorization': f'Bearer <add_your_token_here>',
    },
    timeout=360
)

with open("./generated.pptx", "wb") as file:
    file.write(response.content)

JavaScript

const formData = new FormData();

  formData.append("jsonData", JSON.stringify('{"presentation":{"template":"url of title_slide_template.pptx","export_version":"Pptx2010","resultFileName":"quick_start_example","slides":[{"type":"slide","slide_index":0,"shapes":[{"name":"Title 1","content":"YourgeneratedPowerPointpresentation"},{"name":"Subtitle 2","content":"Create,fillandmanagePowerPointdocumentsthroughsimpleAPIrequests."}]}]}}'));

  const request = new XMLHttpRequest();
  request.open(
    "POST",
    "https://gen.powerpointgeneratorapi.com/v1.0/generator/create",
    true
  );
  request.setRequestHeader(
    "Authorization",
    "Bearer <add_your_token_here>"
  );

  request.responseType = "blob";

  request.onload = function () {
    if (request.readyState === request.DONE && request.status === 200) {
      var blob = new Blob([request.response], {
      type: "application/vnd.openxmlformats-officedocument.presentationml.presentation",
      });
      var link = document.createElement("a");
      link.href = window.URL.createObjectURL(blob);
      link.download = "generated.pptx";
      link.click();      
    }
  };

  request.send(formData);

Postman

1. Enter your Bearer Token in the Authorization tab.

2. In the Body tab add the following parameters: files: upload the .pptx file from the zipped folder above jsonData: copy and paste the data from the zipped folder above

3. Click Send and Download save the output as `.pptx`.

Output .pptx file

You will receive a byte array that can be converted to a PowerPoint presentation. Your PowerPoint will contain a single slide that looks like this: