New Mexico Water Data Act APIs

A JSON Web Token (JWT) is a compact, URL-safe token used for securely transmitting information between parties as a JSON object. It is often used for authentication and authorization purposes in web applications. A JWT is typically composed of three parts: a header, a payload, and a signature. The header contains metadata, such as the type of token and the signing algorithm used. The payload contains claims, which are statements about an entity (usually the user) and additional data. The signature is used to verify the integrity of the token and ensure it hasn’t been tampered with.

1. Utilize the 'Tokens' API located within the 'Authorization' section to acquire a JWT (JSON Web Token).
2. Expand the API section by clicking the arrow on the far right. Once expanded, locate the "The login credentials" section. Inside the white box, replace the word string with your actual UserName and Password, formatted as follows:
   {
  "UserName": "User123",
  "Password": "your password goes here"
}
3. Upon calling the API, retrieve the 'AccessToken' and 'RefreshToken' from the response body.
4. When your JSON Web Token expires, you can obtain a new one by using the 'RefreshTokens' API found in the 'Authorization' section. Instead of providing your 'UserName' and 'Password', use your 'RefreshToken' to acquire a fresh JSON Web Token.

A refresh token is a credential used to obtain a new JSON Web Token without requiring the user to log in again. Unlike a JSON Web Token, which has a short expiration time, a refresh token has a longer lifespan and is typically used to maintain a user's session without frequent re-authentication. When the JSON Web Token expires, the refresh token can be sent to the authentication server to request a new JSON Web Token. This helps improve security by minimizing the exposure of long-lived credentials while maintaining a seamless user experience.

1. Utilize the 'RefreshTokens' API located within the 'Authorization' section to acquire a new JWT (JSON Web Token).
2. Expand the API section by clicking the arrow on the far right. Once expanded, locate the "The login credentials" section. Inside the white box, replace the word string with your actual UserName and RefreshToken, formatted as follows:
   {
  "UserName": "User123",
  "RefreshToken": "your refresh token string goes here"
}
3. Upon calling the API, retrieve the 'AccessToken' and 'RefreshToken' from the response body.
4. When your JSON Web Token expires, you can obtain a new one by repeating the proceeding steps.

If you’ve forgotten your password, don’t worry! You can easily reset it by using the "Forgot Password" feature. Simply click on the "Forgot password" link on the login page, and you’ll be prompted to enter your registered email address. We’ll send you an email with instructions on how to reset your password. Follow the steps in the email to create a new password and regain access to your account. If you don’t receive the email or need further assistance, please contact our support team for help.

If you haven’t received the email confirmation link for your account, please check the following:

1. Spam or Junk Folder: Sometimes, confirmation emails can end up in your spam or junk folder. Please check there to see if the email was mistakenly filtered.
2. Correct Email Address: Verify that the email address you provided during registration is correct. If there was a typo, you may need to register again with the correct address.
3. Email Delivery Time: Email delivery can occasionally be delayed. Wait a few minutes and check your inbox again.

If you still haven’t received the confirmation email after checking these points, you can request a new confirmation link by visiting the login page and selecting "Resend Confirmation." If the issue persists, please contact our support team for further assistance.

A 429 error indicates that you have made too many requests to the API in a given timeframe and have exceeded the rate limit. This rate limiting is in place to ensure fair usage and to protect the API from being overwhelmed by too many requests in a short period.

To resolve this, you can:

1. Wait and Retry: API access is restricted to a maximum of 600 requests per 1 minute per user. This rolling limit means that if a user exceeds this threshold, they will receive a 429 "Too Many Requests" error. Please note that the rate limit is subject to change, so we recommend checking back frequently to stay informed of any updates.
2. Check Rate Limits: Review the API documentation for details on the rate limits and adjust your request frequency accordingly.
3. Optimize Requests: If possible, optimize your requests to reduce the number of API calls you make. Consider batching requests or caching responses where appropriate.

If you continue to experience issues, contact our contact our support team in understanding your specific rate limits and how to manage your API usage effectively.

To ensure responsible and secure usage, we require users to register for API access.

• Customization: Registered users gain access to a range of customization options, allowing them to tailor their API experience to meet specific needs.
• Usage Monitoring: Registration enables us to monitor API usage, ensuring fair access and optimal performance for all users.
• Security: By registering, users contribute to a secure API environment. This helps us prevent misuse and ensures the integrity of the data.

1. Create an Account: If you don't already have an account, start by creating one on our platform. Provide essential details to set up your profile.
2. Confirm your Account: Before you can access your account, please confirm your email address by clicking the link sent to you during registration. This ensures that the provided email is valid and that you have control over it. This step enhances security by verifying the user's identity and reducing the risk of fraudulent or unauthorized access.
3. API Access Request: Once logged in, navigate to the API Access Request section. Submit a request by providing information about your intended use, project details, and any specific requirements.
4. Verification: Our team will review your request during normal business hours to ensure it aligns with our usage policies. This process may take a short time, and you will receive a notification once your request is approved.
5. Access Credentials: Upon approval, you will be able to use these credentials to obtain a JSON Web Token (JWT) and Refresh Token needed to access the APIs. Keep this information secure, as it will be essential for authenticating your API requests.
6. Testing and Documentation: Access our powerful tool for testing and viewing API documentation. We provide an interactive user interface that allows developers to visualize, explore, and test endpoints of an API in a user-friendly format, helping to ensure that the API behaves as expected and is well-documented.

To request a new API or a change to an existing one, please complete the User Request for New API or Change to Existing API form. Here’s a step-by-step guide to help you fill out the form:

1. Full Name and Email: Provide your full name and a valid email address so we can contact you if we have any questions about your request.
2. Organization Name: Enter the name of your organization to help us understand the context of your request.
3. Title: Brief descriptive title for the request change (i.e. New API for well dates).
4. New API or Change Request: Indicate whether you are requesting a new API or a modification to an existing one.
5. API Endpoint: When requesting changes to an existing API, provide path to the API (i.e. /OCD/WellPermitting/Well)
6. Reason for Request: Explain why you need the API or the change. This helps us assess the priority and impact of your request.
7. Data Requested: Describe the specific data or services you are looking to access through the API.
8. Data Filters: If applicable, provide any filters (such as date ranges or specific parameters) you need applied to the data.
9. Current Data Source (if applicable): If you already have a data source but are looking to transition to our API, provide details about your current setup.
10. Timeline: Let us know if there is an urgent deadline for your request. This helps us prioritize accordingly.
11. Additional Notes: Use this field for any other relevant details or special instructions.

Once you’ve submitted the form, our team will acknowledge receipt of your request, review it thoroughly, and contact you if further clarification is needed. We’ll keep you updated throughout the process.

We hope this FAQ section has answered your questions. If you need further assistance, don't hesitate to reach out to our support team. We're here to help and ensure you have the best experience possible.