Pular para o conteúdo principal

Introdução à API XD Soba

Bem-vindo à documentação da API XD Soba! Este guia vai ajudá-lo a compreender como utilizar a nossa API de forma eficiente.

Início Rápido​

  1. Leia o Guia de Primeiros Passos para aprender sobre:

    • Autenticação
    • URL Base
    • Cabeçalhos comuns
    • Rate limiting
    • Tratamento de erros

  2. Explore a Referência da API para:

    • Ver todos os endpoints disponíveis
    • Gerar exemplos de código
    • Testar chamadas à API diretamente

Usar Comandos cURL​

A documentação inclui exemplos cURL para cada endpoint. Veja como utilizá-los:

  1. Windows PowerShell:

    # Linha única
    curl -X POST "https://api.xdsoba.com/gateway/auth/login" -H "Content-Type: application/json" -d '{"user": "seu_utilizador", "password": "sua_palavra_passe"}'

    # Múltiplas linhas (usando backticks)
    curl -X POST "https://api.xdsoba.com/gateway/auth/login" `
         -H "Content-Type: application/json" `
         -d '{"user": "seu_utilizador", "password": "sua_palavra_passe"}'

  2. Terminal Linux/Mac:

    # Linha única
    curl -X POST "https://api.xdsoba.com/gateway/auth/login" -H "Content-Type: application/json" -d '{"user": "seu_utilizador", "password": "sua_palavra_passe"}'

    # Múltiplas linhas (usando barras invertidas)
    curl -X POST "https://api.xdsoba.com/gateway/auth/login" \
         -H "Content-Type: application/json" \
         -d '{"user": "seu_utilizador", "password": "sua_palavra_passe"}'

Gerar Código​

A secção Referência da API permite gerar código em múltiplas linguagens:

  1. Navegue para qualquer endpoint na Referência da API
  2. Clique na aba "Code"
  3. Selecione a sua linguagem preferida:
    • cURL
    • C#
    • JavaScript
    • Python
    • Java
    • PHP
    • Ruby
    • Go
    • PowerShell

Exemplo de código C# gerado:

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

Próximos Passos​

Precisa de ajuda? Contacte a nossa equipa de suporte em support@xdsoba.com