OASIS API Reference for Alpha Testers

Base URLs

Development: https://localhost:5002
Staging: https://staging-api.oasisplatform.world
Production: https://api.oasisplatform.world

Authentication

All API requests require authentication via JWT token in the Authorization header:

Authorization: Bearer YOUR_JWT_TOKEN

Avatar Management

Register Avatar

POST /api/avatar/register

Request Body:

{
  "username": "string",
  "email": "string", 
  "password": "string",
  "firstName": "string",
  "lastName": "string"
}

Response:

{
  "result": {
    "id": "guid",
    "username": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "isEmailVerified": false
  },
  "isError": false,
  "message": "Avatar successfully registered"
}

Verify Email

GET /api/avatar/verify-email

Verify avatar email address using token from registration email.

Query Parameters:

token (string, required) - Verification token from email

Response:

{
  "result": true,
  "isError": false,
  "message": "Email successfully verified"
}

Authenticate Avatar

POST /api/avatar/authenticate

Authenticate avatar and receive JWT token.

Request Body:

{
  "username": "string",
  "password": "string"
}

Response:

{
  "result": {
    "id": "guid",
    "username": "string",
    "email": "string",
    "jwtToken": "string",
    "refreshToken": "string",
    "isBeamedIn": true,
    "lastBeamedIn": "2024-01-01T00:00:00Z"
  },
  "isError": false,
  "message": "Avatar successfully authenticated"
}

Get Current Avatar

GET /api/avatar/current

Get details of currently authenticated avatar.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Response:

{
  "result": {
    "id": "guid",
    "username": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "karma": 0,
    "avatarType": "User",
    "isBeamedIn": true,
    "wallets": [],
    "nfts": []
  },
  "isError": false
}

Update Avatar

PUT /api/avatar/{id}

Update avatar information.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Request Body:

{
  "firstName": "string",
  "lastName": "string",
  "email": "string"
}

Delete Avatar

DELETE /api/avatar/{id}

Delete avatar account.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

NFT Management

Mint NFT

POST /api/nft/mint-nft

Mint a new NFT using specified providers.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Request Body:

{
  "OnChainProvider": "ArbitrumOASIS",
  "OffChainProvider": "MongoDBOASIS",
  "AvatarId": "guid",
  "WalletAddress": "string",
  "Title": "string",
  "Description": "string",
  "ImageUrl": "string",
  "MetaData": {
    "property1": "value1",
    "property2": "value2"
  }
}

Response:

{
  "result": {
    "oasisnft": {
      "id": "guid",
      "title": "string",
      "description": "string",
      "imageUrl": "string",
      "hash": "string",
      "mintedByAddress": "string",
      "mintedOn": "2024-01-01T00:00:00Z"
    },
    "transactionResult": "0x..."
  },
  "isError": false,
  "message": "Successfully minted the NFT"
}

Load NFT

GET /api/nft/load-nft/{id}

Load NFT details by ID.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Response:

{
  "result": {
    "id": "guid",
    "title": "string",
    "description": "string",
    "imageUrl": "string",
    "hash": "string",
    "mintedByAddress": "string",
    "mintedOn": "2024-01-01T00:00:00Z",
    "metaData": {}
  },
  "isError": false
}

Load NFTs for Avatar

GET /api/nft/load-nfts-for-avatar/{avatarId}

Load all NFTs owned by specific avatar.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Response:

{
  "result": [
    {
      "id": "guid",
      "title": "string",
      "description": "string",
      "imageUrl": "string"
    }
  ],
  "isError": false
}

Data Management

Save Holon

POST /api/data/save-holon

Save a data holon (generic data object).

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Request Body:

{
  "name": "string",
  "description": "string",
  "holonType": "string",
  "parentHolonId": "guid",
  "metaData": {}
}

Response:

{
  "result": {
    "id": "guid",
    "name": "string",
    "description": "string",
    "holonType": "string",
    "parentHolonId": "guid",
    "createdDate": "2024-01-01T00:00:00Z"
  },
  "isError": false,
  "message": "Holon successfully saved"
}

Load Holon

GET /api/data/load-holon/{id}

Load holon by ID.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Load Holons for Parent

GET /api/data/load-holons-for-parent/{parentId}

Load all child holons for a parent holon.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Delete Holon

DELETE /api/data/delete-holon/{id}

Delete holon by ID.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Provider Management

Get Current Storage Provider

GET /api/provider/get-current-storage-provider

Get currently active storage provider.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Response:

{
  "result": {
    "providerName": "MongoDBOASIS",
    "providerDescription": "MongoDB Provider",
    "providerType": "MongoDBOASIS",
    "isProviderActivated": true
  },
  "isError": false
}

Get Current Storage Provider Type

GET /api/provider/get-current-storage-provider-type

Get currently active storage provider type.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Get All Registered Providers

GET /api/provider/get-all-registered-providers

Get list of all registered providers.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Activate Provider

POST /api/provider/activate-provider/{providerType}

Activate specific provider.

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Path Parameters:

providerType (string) - Provider type to activate

Provider-Specific Endpoints

Most endpoints support provider-specific versions with the format: /api/{controller}/{action}/{providerType}/{setGlobally}

Parameters:

providerType (string) - Provider to use for this request
setGlobally (boolean) - Whether to set provider globally for future requests

Examples:

Register with Specific Provider

POST /api/avatar/register/MongoDBOASIS/false

Mint NFT with Specific Provider

POST /api/nft/mint-nft/ArbitrumOASIS/true

Mint NFT using Arbitrum provider and set it globally for future requests.

Save Holon with Specific Provider

POST /api/data/save-holon/Neo4jOASIS/false

Save holon using Neo4j provider for this request only.

Available Provider Types

Storage Providers

MongoDBOASIS - MongoDB document database
SQLLiteDBOASIS - SQLite relational database
Neo4jOASIS - Neo4j graph database
LocalFileOASIS - Local file system storage

Blockchain Providers

EthereumOASIS - Ethereum blockchain
ArbitrumOASIS - Arbitrum layer 2
PolygonOASIS - Polygon network
SolanaOASIS - Solana blockchain
EOSIOOASIS - EOSIO blockchain
TRONOASIS - TRON blockchain
RootstockOASIS - Rootstock blockchain

Network Providers

HoloOASIS - Holochain network
IPFSOASIS - IPFS decentralized storage
PinataOASIS - Pinata IPFS service

Error Responses

All endpoints return standardized error responses:

{
  "result": null,
  "isError": true,
  "message": "Error description",
  "detailedMessage": "Detailed error information",
  "errorCount": 1,
  "warningCount": 0
}

Common HTTP Status Codes:

200 - Success
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
500 - Internal Server Error

Rate Limiting

API requests are subject to rate limiting:

Authentication endpoints: 5 requests per minute
General endpoints: 100 requests per minute
NFT operations: 10 requests per minute

Rate limit headers are included in responses:

X-RateLimit-Limit - Request limit per window
X-RateLimit-Remaining - Remaining requests in current window
X-RateLimit-Reset - Time when rate limit resets

WebSocket Support

Some endpoints support WebSocket connections for real-time updates:

Connection

const ws = new WebSocket('wss://localhost:5002/ws');

ws.onopen = function() {
    // Send authentication
    ws.send(JSON.stringify({
        type: 'auth',
        token: 'YOUR_JWT_TOKEN'
    }));
};

ws.onmessage = function(event) {
    const data = JSON.parse(event.data);
    // Handle real-time updates
};

SDKs and Libraries

.NET SDK

using NextGenSoftware.OASIS.API.Core.Managers;

var avatarManager = new AvatarManager();
var result = await avatarManager.AuthenticateAsync("username", "password");

JavaScript SDK

import { OASISClient } from '@oasis/sdk';

const client = new OASISClient('https://localhost:5002');
const result = await client.avatar.authenticate('username', 'password');

Testing with Postman

Import the OASIS API Postman collection:

Download: OASIS API Collection
Import into Postman
Set environment variables:
- baseUrl: https://localhost:5002
- jwtToken: Your JWT token
Run the collection tests

Support

For API support and questions:

Email: ourworld@nextgensoftware.co.uk
GitHub Issues: Create an issue
Telegram: OASIS API Chat
Discord: OASIS Discord

PreviousOASIS WEB4 & WEB5 APIs - Combined Overview NextSTAR API - Complete Endpoints Reference

Last updated 1 month ago

Good morning

hashtagBase URLs

hashtagAuthentication

hashtagAvatar Management

hashtagRegister Avatar

hashtagVerify Email

hashtagAuthenticate Avatar

hashtagGet Current Avatar

hashtagUpdate Avatar

hashtagDelete Avatar

hashtagNFT Management

hashtagMint NFT

hashtagLoad NFT

hashtagLoad NFTs for Avatar

hashtagData Management

hashtagSave Holon

hashtagLoad Holon

hashtagLoad Holons for Parent

hashtagDelete Holon

hashtagProvider Management

hashtagGet Current Storage Provider

hashtagGet Current Storage Provider Type

hashtagGet All Registered Providers

hashtagActivate Provider

hashtagProvider-Specific Endpoints

hashtagParameters:

hashtagExamples:

hashtagRegister with Specific Provider

hashtagMint NFT with Specific Provider

hashtagSave Holon with Specific Provider

hashtagAvailable Provider Types

hashtagStorage Providers

hashtagBlockchain Providers

hashtagNetwork Providers

hashtagError Responses

hashtagCommon HTTP Status Codes:

hashtagRate Limiting

hashtagWebSocket Support

hashtagConnection

hashtagSDKs and Libraries

hashtag.NET SDK

hashtagJavaScript SDK

hashtagTesting with Postman

hashtagSupport

Base URLs

Authentication

Avatar Management

Register Avatar

Verify Email

Authenticate Avatar

Get Current Avatar

Update Avatar

Delete Avatar

NFT Management

Mint NFT

Load NFT

Load NFTs for Avatar

Data Management

Save Holon

Load Holon

Load Holons for Parent

Delete Holon

Provider Management

Get Current Storage Provider

Get Current Storage Provider Type

Get All Registered Providers

Activate Provider

Provider-Specific Endpoints

Parameters:

Examples:

Register with Specific Provider

Mint NFT with Specific Provider

Save Holon with Specific Provider

Available Provider Types

Storage Providers

Blockchain Providers

Network Providers

Error Responses

Common HTTP Status Codes:

Rate Limiting

WebSocket Support

Connection

SDKs and Libraries

.NET SDK

JavaScript SDK

Testing with Postman

Support