Skip to main content

Introduction to XD Soba API

Welcome to the XD Soba API documentation! This guide will help you understand how to use our API effectively.

Quick Start​

  1. Read the Getting Started Guide to learn about:

    • Authentication
    • Base URL
    • Common headers
    • Rate limiting
    • Error handling

  2. Explore the API Reference to:

    • View all available endpoints
    • Generate code examples
    • Test API calls directly

Using cURL Commands​

The documentation includes cURL examples for each endpoint. Here's how to use them:

  1. Windows PowerShell:

    # Single line
    curl -X POST "https://api.xdsoba.com/api/Account/login" -H "Content-Type: application/json" -d '{"username": "your_username", "password": "your_password"}'

    # Multi-line (using backticks)
    curl -X POST "https://api.xdsoba.com/api/Account/login" `
         -H "Content-Type: application/json" `
         -d '{"username": "your_username", "password": "your_password"}'

  2. Linux/Mac Terminal:

    # Single line
    curl -X POST "https://api.xdsoba.com/api/Account/login" -H "Content-Type: application/json" -d '{"username": "your_username", "password": "your_password"}'

    # Multi-line (using backslashes)
    curl -X POST "https://api.xdsoba.com/api/Account/login" \
         -H "Content-Type: application/json" \
         -d '{"username": "your_username", "password": "your_password"}'

Generating Code​

The API Reference section allows you to generate code in multiple languages:

  1. Navigate to any endpoint in the API Reference
  2. Click the "Code" tab
  3. Select your preferred language:
    • cURL
    • C#
    • JavaScript
    • Python
    • Java
    • PHP
    • Ruby
    • Go
    • PowerShell

Example of generated C# code:

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.xdsoba.com/api/Account/login");
request.Headers.Add("Content-Type", "application/json");
var content = new StringContent("{\"username\":\"your_username\",\"password\":\"your_password\"}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();

Next Steps​

Need help? Contact our support team at support@xdsoba.com