Read the first chapter
The whole of chapter one, free. About 2 min. Turn the pages with the arrows, your keyboard, or a swipe.
Chapter 1
API Keys & Pore Data Access
Overview
Who should be allowed to read pore-pressure, porosity, and permeability records before they enter crude-oil yield modeling? This chapter defines the Trust-Token Handshake: a scoped API-token exchange that authenticates a client and verifies dataset permissions before data retrieval. Use it when a modeling service needs controlled access to pore datasets by reservoir, project, or sensitivity class.
Quick Reference
| Operation | Method | Endpoint | Purpose | |---|---:|---|---| | Issue access token | POST | /v1/auth/token | Exchange credentials for a scoped token | | List permitted datasets | GET | /v1/pore-datasets | Return datasets visible to the token | | Retrieve dataset | GET | /v1/pore-datasets/{dataset_id} | Fetch pore measurements and metadata | | Filter records | Query | reservoir_id, quality_min | Restrict data used in yield calculations | | Required header | - | Authorization: Bearer | Authenticate each data request |
Parameters
| Parameter | Type | Required | Description | |---|---|---:|---| | client_id | string | Yes | Registered application identifier | | client_secret | string | Yes | Secret used only at the token endpoint | | scope | string | Yes | Permission set, such as pore:read yield:read | | expires_in | integer | No | Token lifetime in seconds; default 3600 | | dataset_id | string | Yes for detail | Dataset identifier, for example pd_7f21 | | reservoir_id | string | No | Restricts results to one reservoir | | quality_min | number | No | Minimum quality score from 0.0 to 1.0; default 0.8 | | limit | integer | No | Records per response; default 100, maximum 1000 |
Code Example
`python import os import requests
BASE_URL = "https://api.example-energy.com" credentials = { "client_id": os.environ["PORE_CLIENT_ID"], "client_secret": os.environ["PORE_CLIENT_SECRET"], "scope": "pore:read yield:read", }
Trust-Token Handshake: authenticate and request only required scopes. token_response = requests.post( f"{BASE_URL}/v1/auth/token", json=credentials, timeout=15, ) token_response.raise_for_status() access_token = token_response.json()["access_token"]
headers = {"Authorization": f"Bearer {access_token}"} params = { "reservoir_id": "R-204", "quality_min": 0.85, "limit": 250, }
dataset_response = requests.get( f"{BASE_URL}/v1/pore-datasets/pd_7f21", headers=headers, params=params, timeout=30, ) dataset_response.raise_for_status()
records = dataset_response.json()["records"] `
Response Format
json { "dataset_id": "pd_7f21", "reservoir_id": "R-204", "permission": "read", "quality_threshold": 0.85, "records": [ { "sample_id": "S-00981", "porosity": 0.184, "permeability_md": 126.4, "pore_pressure_kpa": 28450, "quality_score": 0.93 } ], "next_cursor": null }
permission confirms the granted dataset role. quality_threshold records the applied filter. Pore values must retain their declared units when passed to yield models.
Notes & Best Practices
• Store client_secret and access tokens in a secret manager; never commit them to source control or logs. - Request the narrowest scope required. A token with pore:read should not receive write permissions. - Handle 401 as an expired or invalid token, 403 as insufficient dataset permission, and 429 with bounded exponential backoff. Respect the Retry-After header. - Validate units, reservoir identifiers, and quality scores before modeling. An empty records array is a valid filtered result, not necessarily an authentication failure.
The Trust-Token Handshake establishes the permission boundary that keeps pore measurements traceable as they move into crude-yield calculations.
End of chapter one. 6 more chapters in the full book.
Swipe or use the arrows to turn the page
What's inside: 7 chapters
- 1. API Keys & Pore Data Access
- 2. Create Pore Sample Endpoint
- 3. Get Pore Network Graph Endpoint
- 4. Update Throat Properties Endpoint
- 5. Segment Pore Throats by Thresholds
- 6. Compute Crude Yield from Pore Metrics
- 7. Error Codes, Retries, and Audit Trails
About this book
"Pore Analysis In Reservoir Engineering" is a technical book by Anonymous with 7 chapters and approximately 3,579 words. Pore analysis methods in reservoir engineering for crude yield.
This book was created using Inkfluence AI, an AI-powered book generation platform that helps authors write, design, and publish complete books. It was made with the AI Documentation Generator.
Frequently Asked Questions
What is "Pore Analysis In Reservoir Engineering" about?
Pore analysis methods in reservoir engineering for crude yield
How many chapters are in "Pore Analysis In Reservoir Engineering"?
The book contains 7 chapters and approximately 3,579 words. Topics covered include API Keys & Pore Data Access, Create Pore Sample Endpoint, Get Pore Network Graph Endpoint, Update Throat Properties Endpoint, and more.
Who wrote "Pore Analysis In Reservoir Engineering"?
This book was written by Anonymous and created using Inkfluence AI, an AI book generation platform that helps authors write, design, and publish books.
How can I create a similar technical book?
You can create your own technical book using Inkfluence AI. Describe your idea, choose your style, and the AI writes the full book for you. It's free to start.
Write your own technical book with AI
Describe your idea and Inkfluence writes the whole thing. Free to start.
Start writingCreated with Inkfluence AI
