Skip to content
English
Request a Call
  • There are no suggestions because the search field is empty.

How to Create API Keys in Skupreme ERP

You can generate API keys in Skupreme ERP to access your inventory data and create orders programmatically through our Open API system. This guide will walk you through creating API keys, testing them, and following best practices for security and integration.

What You’ll Need

  • Access to your Skupreme ERP account

  • Admin permissions to access Settings

  • A basic understanding of API concepts

Step-by-Step Guide to Create Your API Key

1. Navigate to API Key Settings

  1. Log into your Skupreme ERP account.

  2. Go to Settings from the main navigation.

  3. Click on the Keys tab.

  4. This section contains all your API key management tools.

2. Generate a New API Key

  1. Click Create New Key (or similar button).

  2. Enter a descriptive name for your key (e.g., “Test Key for Integration”).

  3. Optionally, add a description to identify the key’s purpose.

  4. Click Generate to create your API key.

  5. Important: Copy and securely store your API key immediately — it will not be shown again.

Accessing the API Documentation

Once your key is created:

  • Visit the API documentation at https://public.skupreme.com/docs

  • Use the interactive testing features available there

  • You can test API calls directly from the documentation interface

Testing Your API Key

Test Inventory Access

  1. Open the Inventory section in the API docs.

  2. Paste your API key into the authentication field.

  3. Run a test call to verify your key is working.

  4. You should see live inventory data from your account.

Create a Test Order

The API allows you to create orders programmatically.

Required Fields:

  • SKU: Use the primary display SKU from your inventory

  • State: Two-letter state abbreviation (e.g., “CA”, “NY”)

  • UPC: Optional but recommended for catalogs with multiple SKUs

Optional Fields:

  • Customer email

  • Order memo or notes

  • Additional product identifiers

Sample JSON Guidelines:

  • Include commas after each field except the last

  • Validate your JSON using tools like JSONLint

  • Ensure all required fields are present — missing fields will trigger errors

Best Practices

Security

  • Store API keys securely — never expose them in client-side code.

  • Use environment variables for storage.

  • Rotate keys regularly for enhanced security.

API Usage

  • Test API calls in the documentation interface first.

  • Use UPC codes for catalogs with complex SKU structures.

  • Validate JSON formatting to prevent syntax errors.

Error Handling

  • Common errors include missing commas or invalid JSON.

  • Ensure all required fields are included.

  • Use the interactive API docs to troubleshoot error responses.

Next Steps

After creating your API key:

  1. Test basic inventory queries.

  2. Practice creating test orders.

  3. Integrate the API into your system or application.

  4. Monitor your API usage and performance.

 

 

 

Troubleshooting

Issue Possible Cause Solution
Formatting errors Invalid JSON syntax Validate your JSON at jsonlint.com
Authentication errors Incorrect or missing API key Confirm your key is correctly copied and included in requests
Order creation failures Missing required fields Review field list and ensure correct formatting

Additional Resources