API Information and Installation Process

02/06/2024 1:31 pm EST

Contents

Purpose
What is an API
API Types
Viewing the Customer's API
Locating the API URL
API Internal Login
API Limited vs API Full
New Installation
Upgrade Installation

Purpose

The purpose of this document is to help explain what the API is, what applications require it to connect to SedonaOffice, and how to schedule installation.

What is an API

The API is the middleman that allows SedonaOffice add-on modules to push or pull data to/from SedonaOffice databases. A user is set up in the API and is linked to a specific company/database. Based on the user login, the add-on module then knows which SedonaOffice database to interact with.

The following products are examples of those that use the API to integrate with SedonaOffice:

  • Time and Attendance
  • Sales Automation
  • eForms
  • Sedona-X Mobile
  • SedonaWeb

Top of Document

API Types

There have been many variations of the API sold under many names:

  • API 1.0 - Legacy API that works with SedonaOffice On-Prem or Hosted Customers
    • Also known as SedonaWeb 1.0
      • In Octopus - shown as SedonaAPI
    • Is no longer sold
  • API 2.0 Limited Version - allows connection between SedonaOffice and add-on modules only
    • Also sold as SedonaWeb 2.0 if the customer is deploying a customer portal
  • API 2.0 Full - has the same functionality as the Limited version, however, also allows customers to build 3rd party integrations to push/pull data
    • Also sold as SedonaWeb 2.0 if the customer is deploying a customer portal
    • Also sold as SedonaOffice REST API
    • in Octopus - shown as SedonaCloud

Top of Document

Viewing the Customer's API

To confirm which version the customer may have if any, follow the steps below

  1. Open Octopus
  2. Enter the Customer Name in the 'Filter by Project Name' field
  3. Look for records for the customer
    1. Note that common customer names may require further research to confirm the correct customer API
  4. Determine API Type

API-Octopus Customer View.pngTop of Document

Locating the API URL


To find the API URL, from the screen shown above:

  1. Click the Customer's name
  2. Click 'Variables'
  3. Scroll to the bottom of the screen and locate 'Urls: URL'
  4. Copy the URL

API-Octopus Customer URL2.pngTop of Document

API Internal Login Information

To access a customer's API to view the setup of companies and users, the following login information can be used:

Username: automatedjob
Password: Perennial$0ftware

IMPORTANT NOTE: Do NOT give this login information to any customer! It is internal only. Please be careful logging in, incorrect attempts may require a reset and notification to all internal users of any updated information.

Top of Document

API Limited vs API Full

In regards to the installation of the API Limited vs Full versions, there is no difference between the API or installation. For the Full version, the customer is just given additional information post-installation:

Top of Document

New Installation

For customers without an API, your project should include a task to install the API:

  1. Confirm customer's SedonaOffice version is compatible with the latest release of API
  2. Confirm if the customer's API will be installed On-Prem or Cloud
  3. Kick-off - send customer Kick off Email
    1. Use Template "API Install"
      1. Preinstall checklists will be attached
        1. On Prem: Preinstall Checklist - SEdonaWeb (Limited API) On-Prem
        2. Cloud: Preinstall Checklist - SEdonaWeb (Limited API) - Cloud
        3. Backup copies are available in Implementation and Installation Forms
  4. Confirm preinstall information is received (from Kick off email)
  5. From the project task, update the Description field to include "Install API Type" (where the type matches what was sold on the contract) installation
  6. Estimated Time field:
    1. Hosted Customer - 2 hours
      1. Can be combined with other module installations time permitting
    2. On-Prem Customer - 8 hours
  7. In task Chatter, include information on the type of API to install
    1. Limited
    2. Full
      1. Include a note to provide
        1. ClientID
        2. ClientSecret
  8. Installation Completed - Tech will provide API Information
    1. URL and username/login information
    2. Full version ClientID and Client Secret (if applicable)
  9. Schedule API training - 1 hr (or more if additional sold)
    1. Can be done in conjunction with other module training time permitting
  10. Send information to the customer using a secure email

Top of Document

Upgrade Installation

To schedule an API upgrade, follow the steps below:

  1. From the project task, update the Description field to include 'Upgrade API'
  2. Estimated Time field:
    1. Hosted Customer - 2 hours
      1. Can be combined with other module installations time permitting
    2. On-Prem Customer - 8 hours
  3. In task Chatter, include information on the type of API to install
    1. Limited
    2. Full
      1. Include a note to provide
        1. ClientID
        2. ClientSecret
  4. Installation Completed - Tech will provide API Information
    1. URL and username/login information
    2. Full version ClientID and Client Secret (if applicable)
  5. Send information to the customer using a secure email


Top of Document

Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted for approval.

Copyright © 2024-26 Bold Group All rights reserved.