Skip to main content

YetiForce API User Configuration

There's a time and place for everything, maybe not now.

This guide supposes that you have already followed the Setting Up Your Environment guide. If you haven't done so, please refer to the Setting Up Your Environment guide before proceeding.

Overview​

Setting up API users in YetiForce involves two main steps:

  1. Creating a Web Service Application
  2. Creating a Web Service User

This guide will walk you through each step carefully, ensuring you have the correct credentials for API integration.

Prerequisites​

  • Access to YetiForce admin panel
  • Administrative permissions
  • Prepared application name and password

Step 1: Create Web Service Application​

Accessing Web Services Configuration​

  1. Log into YetiForce admin panel
  2. Click on the gear icon (gearbox) in the top right corner
  3. Navigate to "Integration" in the left sidebar
  4. Select "Web Services Applications"

Creating Application Credentials​

  1. Click "Add Key" in the top right of the screen
  2. Enter an application name (will be referenced as $APPLICATION_NAME$)
    • Choose a descriptive, memorable name
    • Example: MyPythonIntegration or DataSyncApp
  3. Create a strong password (will be referenced as $APPLICATION_PASSWORD$)
    • Use a combination of uppercase, lowercase, numbers, and symbols
    • Avoid easily guessable passwords
  4. Enable the status checkbox
  5. Save the configuration
Password Security
  • Use a unique, complex password
  • Avoid reusing passwords from other systems
  • Consider using a password manager to generate strong credentials

Step 2: Create Web Service User​

Accessing Web Service Users​

  1. Click on the top right menu
  2. Select "Web Service - Users"
  3. Click "Add Record" in the top left

Configuring User Details​

  1. Server Selection

    • Choose the previously created application ($APPLICATION_NAME$)

  2. User Status

    • Set status to "Active"

  3. Authentication

    • Password: Enter $APPLICATION_PASSWORD$
    • Type: Select "Permissions Based on User"
    • Permission Profile: Choose an admin profile
    • Authentication Method: Select "Password"
    • Language: Select "English"

  4. Save the configuration

Step 3: Retrieve Additional Credentials​

Capturing Required Information​

  1. After saving, locate the new user entry in the list
  2. Copy the email address from the login column
    • This will be referenced as $DATABASE_USER_MAIL$

Obtaining Application Key​

  1. Click the top right green button (Webservice Application)
  2. Find the application with name $APPLICATION_NAME$
  3. Click the copy button
    • If no "copied" prompt appears, refresh the page (F5 or reload)
  4. The copied value is your $APPLICATION_KEY$

Troubleshooting​

  • Ensure all steps are completed in order
  • Double-check that the application and user are both active
  • Verify credentials match exactly when implementing in your code
Credential Management
  • Never share these credentials publicly
  • Store them securely, preferably in environment variables
  • Rotate credentials periodically for enhanced security

Next Steps​

  • Use the captured credentials ($APPLICATION_NAME$, $APPLICATION_PASSWORD$, $DATABASE_USER_MAIL$, $APPLICATION_KEY$) in your Python integration code
  • Test API connectivity to confirm successful configuration