Welcome to our API documentation!

This guide is designed to provide you, as an external developer, with all the necessary information and resources to successfully integrate and utilize our APIs in your applications.

Our documentation will serve as a comprehensive reference to help you understand and interact with our APIs effectively.

☰

Our APIs

Our APIs provide a powerful and flexible way to access and interact with various functionalities of our software platform. With our APIs, you can leverage the full potential of our platform's features and integrate them seamlessly into your own applications. We offer a range of APIs that cover different aspects of our solution, allowing you to create dynamic and customized solutions tailored to your specific needs.

Leases

Simplify lease administration by leveraging APIs to create, update, and manage access.

Wells

Create, update, and retrieve well records, monitor well performance, and streamline well management processes.

Readings

Automate the capture, processing, and analysis of readings. Use APIs to submit and retrieve readings, track variables, and optimize resource management.

Getting Started

To begin using our APIs, you'll need to follow a few simple steps:

  1. Sign up: If you haven't already done so, sign up for an account on our digitaloilfield.app portal. This will give you access to your unique API key and other necessary credentials.

  2. Authentication: Our APIs use token-based authentication. You'll need to include your API key in the headers of your API requests to authenticate and authorize your access.

  3. API Endpoints: Familiarize yourself with the available API endpoints. Each API endpoint represents a specific functionality or resource that you can interact with. Our documentation provides detailed information on each endpoint, including the request/response formats and any required parameters.

  4. API Requests: Once you understand the endpoint you want to use, construct the appropriate API request. This includes specifying the HTTP method, endpoint URL, request headers, and any required parameters or data.

  5. Handling Responses: Our APIs return responses in a structured JSON format. Make sure you understand the response format and know how to handle the data returned by the API effectively.

Our API documentation is organized into several sections to help you navigate and find the information you need quickly.

GET /api/wells

{
    count: "123",
    rows: [{
        id: 1,
        name: "Well 1",
        ...
    },
    ...
    ]
}

- API Reference: We provide detailed information about each API endpoint, including the request/response formats, authentication requirements, and example code snippets.

- Support: We understand that integrating APIs can sometimes be challenging, and we're here to support you along the way. If you have any questions, encounter issues, or need assistance, don't hesitate to reach out to our developer support team.