Skip to content

API User Guide#

This document provides the guide to getting started on the Neoflow platform and building integrations with the REST APIs exposed. The intended audience is a software developer well acquainted with REST APIs and JSON. With that knowledge, the Swagger API Documentation will be the best place to start testing and exploring the platform APIs.

Swagger API Documentation#

The REST APIs in Neoflow follow the OpenAPI standard specifications. These API endpoints are documented using the OpenApi Specification.

Swagger URL - https://api.mavennet.com/

Authentication#

As Neoflow is an invite-only platform, client credentials are required to integrate with Neoflow REST APIs. API calls without the authentication token will fail.

Please visit https://neoflow.energy to begin the onboarding process.

Products API#

A product can be any petroleum-based product, such as crude oil streams, bitumen or natural gas. The product information is stored in the form of a verifiable credential issued by the organization who created it.

Below are the set of functions that can be carried out on the product. Please be sure to have the authentication material at hand before beginning to work with the API endpoints.

Creation#

The products can be created and fetched in the Neoflow platform using below set of API endpoints. When a product is created, a corresponding creation of the product event is also stored in Neoflow. Each product and the event is uniquely identified with a UUID.

POST /v1/products  
GET /v1/products  
GET /v1/products/{id}

Transport#

The custodian organization transports the product from one location to another. This movement is recorded in Neoflow in the form of start and end transport events. Bill of Lading details are captured at during this process. Transport events support correction of the details using the VC revocation standards.

POST /v1/products/transport  
PUT /v1/products/transport

Share#

The owner of the product can share or unshare the product with another organization(s). If the product is shared, an organization can access all the product details such as product's physical and chemical specifications, associated events with their location of occurrence, origin, product's composition/traceablility hierarchy and uploaded documents if any.

POST /v1/products/share  
GET /v1/products/share  
DELETE /v1/products/share

HTTP Status Codes & Errors#

Neoflow uses conventional HTTP response codes to indicate the success or failure of an API request. An exhaustive list for the same can be found here.

Support#

Please contact support at support@neoflow.energy.