Personal API keys allow users to securely access the FieldInsight Public API without needing to complete an OAuth authorization flow each time they make a request. They are intended for server-to-server integrations, automation scripts and other trusted use cases where a user or developer needs direct API access.What is a personal API key?#
A personal API key is a private secret code that allows an application or script to access an API on behalf of a specific user. It works like a digital password for API requests — once the key is added to the request, the system knows who is making the request and what data or actions they are allowed to access. Users usually create personal API keys manually in their account settings and can revoke them at any time if needed.You should treat your API key like a password. Anyone with access to the key may be able to access your FieldInsight data through the API.Generating a personal API key#
To create a personal API key:4.
Copy the key and store it securely.
Making an API request#
Include your personal API key in the request headers when calling the Public API.Replace YOUR_PERSONAL_API_KEY with your actual key.Keeping your API key secure#
Do not share your API key publicly.
Do not commit it to source control.
Store it in environment variables or a secrets manager.
Rotate the key if you think it has been exposed.
Delete keys that are no longer used.
Revoking or rotating a key#
If a key is no longer needed, or if it may have been exposed, revoke it from the API access settings.1.
Create a new personal API key.
2.
Update your application or script to use the new key.
3.
Test that API requests still work.
Modified at 2026-05-08 23:32:10
