WEB4 OASIS API - Complete Endpoints Reference

📋 Overview

This document provides a comprehensive reference of ALL WEB4 OASIS API endpoints, organized by controller and functionality. This is the definitive guide for all available endpoints in the OASIS Web API.

🔗 Base URLs

Development

https://localhost:5000/api

Production

https://api.oasisplatform.world

🔐 Authentication

API Key Authentication

Authorization: Bearer YOUR_OASIS_API_KEY

Avatar Authentication

Authorization: Avatar YOUR_AVATAR_ID

📚 Complete API Endpoints

Core Controllers

Avatar Controller

GET /api/avatar/provider-keys/{id} # Get avatar provider keys POST /api/avatar/update-avatar-detail # Update avatar details POST /api/avatar/update-avatar-email # Update avatar email POST /api/avatar/update-avatar-username # Update avatar username POST /api/avatar/update-avatar-password # Update avatar password POST /api/avatar/forgot-password # Request password reset POST /api/avatar/reset-password # Reset password POST /api/avatar/verify-email # Verify email address POST /api/avatar/resend-verification # Resend email verification

Karma Controller

NFT Controller

Search Controller

Wallet Controller

Keys Controller

OLand Controller

Files Controller

Chat Controller

Messaging Controller

Social Controller

Share Controller

Settings Controller

Seeds Controller

Stats Controller

Video Controller

Solana Controller

Telos Controller

Holochain Controller

ONODE Controller

ONET Controller

Settings Controller

Map Controller

Chat Controller

Messaging Controller

Social Controller

Files Controller

Keys Controller

Provider Controller

HyperDrive Controller

Subscription Controller

OLand Controller

Competition Controller

Gifts Controller

Eggs Controller

Seeds Controller

Share Controller

EOSIO Controller

Data Controller

EOSIO Controller

Mission Controller

Quest Controller

Map Controller

OAPP Controller

Cargo Controller

Gifts Controller

Eggs Controller

Provider Controller

🔧 Common Operations

CRUD Operations

All controllers support the standard CRUD operations:

  • Create: POST /api/{controller}

  • Read: GET /api/{controller} and GET /api/{controller}/{id}

  • Update: PUT /api/{controller}/{id}

  • Delete: DELETE /api/{controller}/{id}

Provider Operations

All endpoints support provider-specific operations:

  • Provider Selection: Specify providerType parameter

  • Global Setting: Use setGlobally parameter

  • Auto-Failover: Automatic provider switching

Authentication Operations

  • Avatar Authentication: All endpoints support avatar-based authentication

  • API Key Authentication: All endpoints support API key authentication

  • Token Refresh: Automatic token refresh for expired sessions

📊 Response Format

All endpoints return responses in the following format:

🔐 Error Handling

All endpoints include comprehensive error handling:

  • 400 Bad Request: Invalid request data

  • 401 Unauthorized: Authentication required

  • 403 Forbidden: Insufficient permissions

  • 404 Not Found: Resource not found

  • 500 Internal Server Error: Server error

🎯 Provider Support

Supported Providers

  • Blockchain: Ethereum, Solana, Telos, EOSIO, Holochain

  • Database: MongoDB, PostgreSQL, SQL Server, MySQL

  • Storage: IPFS, AWS S3, Azure Blob, Google Cloud Storage

  • Cloud: AWS, Azure, Google Cloud Platform

Auto-Failover

  • Intelligent Switching: Automatically switches between providers

  • Performance Monitoring: Real-time performance tracking

  • Cost Optimization: Selects most cost-effective provider

  • Geographic Optimization: Routes to nearest provider

📱 SDKs

JavaScript/Node.js

C#/.NET

Python

🚀 Getting Started

  1. Get API Key: Sign up for an OASIS API key

  2. Choose SDK: Select your preferred SDK

  3. Initialize Client: Set up the API client

  4. Start Building: Use the endpoints to create amazing applications

📞 Support


This is the complete reference for all WEB4 OASIS API endpoints. For detailed documentation of each endpoint, see the individual controller documentation.

Last updated