API Overview

Introduction to Okto API

Okto provides a comprehensive set of APIs for integrating Web3 functionality into any application. This guide will help you understand the core architecture, authentication flow, and how to effectively integrate with our APIs.

API Architecture

Okto's API landscape consists of two distinct types of APIs:

JSON-RPC Methods

• Description: Direct calls to the Okto Gateway
• Endpoint: https://sandbox-okto-gateway.oktostage.com/rpc
• Used for: Authentication and Execute User Operations (Intents)

REST APIs

• Description: Calls to the Okto Gateway through a BFF service
• Endpoint: https://sandbox-apigw.oktostage.com
• Used for: Explorer functions (portfolio, wallets, tokens, etc.)

Authentication Flow

The Authentication Flow is performed on the client-side and consists of these steps:

1. Login Using OAuth - User authenticates through your chosen OAuth provider
2. Generate Session Key - Create a cryptographic key pair for securing the session
3. Create Auth Payload - Construct the necessary data with OAuth token and provider. The Auth Payload is a user operation which contains the callData, paymaster details and gas details.
4. Call Authenticate JSON-RPC - Send the payload to Okto's JSON-RPC gateway
5. Receive User SWA - Obtain the user's Smart Wallet Address

At this point, authentication is successful.

For delegated actions and to execute explorer functions and API calls, you will need to store session info and generate auth token. For this you will need to perform these additional steps:

1. Create Session Config - Create a session configuration using stored session details and user SWA
2. Generate Auth Token - Create the Okto Auth Token needed for API calls
3. Use Auth Token for API Calls - Include the token in all subsequent API requests

The Okto Auth Token generated at the end of the authentication flow is necessary for all explorer functions and API calls.

To immediately test out the explorer functions, you can generate an auth token using the Okto Auth Token Generator tool described below.

Using the Okto Auth Token Generator Tool

The Okto Auth Token Generator simplifies the authentication process for testing purposes. This tool handles all the steps above and provides you with an Okto Auth Token.

Using the Auth Token

After successful authentication and the generation of the Okto Auth Token, you will need to include the Auth Token in all subsequent API calls:

# For REST APIs
curl -X GET https://sandbox-apigw.oktostage.com/api/oc/v1/wallets \
  -H "Authorization: Bearer <your-okto-auth-token>"
 
# For JSON-RPC methods
curl -X POST https://sandbox-okto-gateway.oktostage.com/rpc \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-okto-auth-token>" \
  -d '{"jsonrpc":"2.0","method":"execute","params":[...],"id":"request-id"}'

Getting Started

To start integrating with Okto APIs:

Explore API

Need further assistance?