Authentication
You want to interact with our API? It's simple, but one step is essential: authentication. For this, our API requires the use of an API key.
By default, API key generation is not enabled and won't be visible in the IrrigEasy user interface. If you wish to use our API, please contact us directly. Our team will assist you in activating this feature for your account.
Why is an API Key Necessary?
An API key is a unique string of characters that identifies you and validates your access to the API. Think of it as your personal digital key. Without this key, all your API requests will be rejected for security reasons.
It ensures that only authorized applications and users can access our services, protecting the integrity of our data and the security of our platform.
Generating Your API Key
- Log in to your IrrigEasy account.
- Navigate to the "API Keys" section (the exact name may vary slightly).
- Look for an option labeled "Generate New API key" or similar.
- Give it a name and click the "Generate" button. Your new API key will be displayed only once.
- Copy this key immediately and store it securely. For security reasons, it won't be shown again.
How to Use Your API Key
Your API Key must be included in the header of every HTTP request you send to the API, typically in the format Authorization: Api-Key <your_key>.
Managing Your API Keys
It's crucial to manage your API keys effectively to maintain secure and uninterrupted access to IrrigEasy. Please note that API keys are valid for one year from their generation date.
To ensure continuous API access, remember to renew your keys annually. You can generate new keys through the IrrigEasy interface before your current ones expire. This simple step helps keep your integrations secure and operational.