Frequently Asked Questions (FAQ)
1. Does the API support multi-threading?
The current API does not support multi-threading We are considering adding multi-threading support in the future for improved performance and scalability. For further inquiries or suggestions, please contact support@whitson.com.
2. Is there a limit on requests per minute?
No, but they have to processed in series, meaning one have to finish for the next to begin.
3. How do I report a bug or request a new feature?
If you encounter a bug or have a feature request, please send an e-mail us directly to support@whitson.com.
4. What is the API Swagger documentation and where can I find it?
The API Swagger documentation provides a comprehensive and interactive guide to all the API endpoints, including request and response formats. You can access the Swagger documentation here. This resource is invaluable for understanding how to effectively use the API, and is dynamically updated as more functionality becomes available.
5. Are there any SDKs or client libraries available for the API?
We recommend using our Python helper library, whitson_connect, especially if you have limited experience with APIs. This library simplifies the integration process and is available for download here.
6. Can the API handle bulk data uploads?
Yes, some of the API endpoints are designed to edit or upload data for multiple wells at the same time. Some examples are here:
- Edit many well header properties for many wells at the time
- Upload production data for many wells at the same time
7. What is the API's uptime and maintenance schedule?
We strive to maintain an uptime of 99.9%. Scheduled maintenance is typically performed during off-peak hours and is announced in advance.
8. How do I get access to the API credentials?
To get access to the API credentials, please send an email to support@whitson.com. We will provide you with your CLIENT_ID and CLIENT_SECRET through a secure OneTime secret link. This ensures that your credentials are transmitted safely and can only be accessed once.
9. Does the API support pagination?
Yes, the API supports pagination for endpoints that return large sets of data. Use query parameters such as page and limit to control the number of results returned per page. One example can be found here.
10. How can I secure my API requests?
To secure your API requests, always use HTTPS to encrypt data transmitted between your application and the API.