Understanding the New "API Name" Field for Custom Fields

At ZenQMS, we're always looking for ways to make our system more powerful and easier for you to use, especially when it comes to connecting with other systems you use. We've recently added a new field called "API Name" to your custom fields, and this article will explain what it is and why it's important for you.

What is an "API Name"?

You can think of an "API Name" as a special, secret code or nickname for your custom fields. While you see and use the regular "Field Name" in ZenQMS every day (like "Batch Number" or "Issue Category"), computers and other software systems need a very specific, simplified name to talk to that custom field. The "API Name" is that simplified name.

Why Do We Need an "API Name"?

Many companies use our Public API (Application Programming Interface) to connect ZenQMS with their other internal software. This allows them to automatically send information back and forth, saving time and reducing manual work.

Imagine you have a custom field in ZenQMS called "Issue Category". For another system to automatically update or pull information from this field, it can't understand the spaces, parentheses, or capital letters. It needs a simple, consistent name. That's where the "API Name" comes in. It provides a clean, computer-friendly identifier for your custom field.

Key Things to Know About the "API Name":

When you set up a custom field, you'll now see an option to define an "API Name". Here are a few simple rules for this special name:

• Unique: Every "API Name" you create must be unique across all your custom fields. Just like two people can't have the exact same email address, two custom fields can't have the same "API Name".
• Lowercase: All letters in the "API Name" must be lowercase. For example, instead of "IssueCategory", it would be "issuecategory".
• Underscores for Spaces: If your field name has spaces, use underscores (_) instead of spaces in the "API Name". For example, if your custom field is called "Issue Category", its "API Name" might be "issue_category".
• Character limit: there is a 255 character limit on this field.
• Special Characters: Other than the underscore (mentioned above), no other special characters are allowed. 

In simple terms: The "API Name" is designed to help your custom fields "communicate" smoothly with other software systems, making it easier to integrate ZenQMS into your broader operational processes. You'll primarily interact with your regular "Field Name", but the "API Name" works behind the scenes to enable powerful connections.