Getting Started

Welcome to the comprehensive API documentation. This RESTful API provides powerful endpoints for content management, user operations, and documentation services.

RESTful Design

Clean, predictable URLs and HTTP methods

Secure

OAuth 2.0 and API key authentication

JSON API

All responses in JSON format

Base URL

https://api.oscarrondon.com/v1

This API follows REST principles and returns JSON responses. All requests must be made over HTTPS, and include proper authentication headers.

Authentication

All API requests require authentication. We support API key authentication for server-to-server communication.

API Keys

API keys are the primary method for authenticating with our API. Each key is associated with your account and provides access to your data.

Obtaining an API Key

  1. Sign in to your account dashboard
  2. Navigate to the "API Keys" section
  3. Click "Generate New Key"
  4. Copy and securely store your API key
# Your API key will look like this:
sk_live_4eC39HqLyjWDarjtT1zdp7dc

Request Headers

Include your API key in the Authorization header of every request:

curl -H "Authorization: Bearer sk_live_4eC39HqLyjWDarjtT1zdp7dc" \
     -H "Content-Type: application/json" \
     https://api.oscarrondon.com/v1/content
const response = await fetch('https://api.oscarrondon.com/v1/content', {
  headers: {
    'Authorization': 'Bearer sk_live_4eC39HqLyjWDarjtT1zdp7dc',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();
import requests

headers = {
    'Authorization': 'Bearer sk_live_4eC39HqLyjWDarjtT1zdp7dc',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.oscarrondon.com/v1/content', headers=headers)
data = response.json()

Quick Start

Get up and running with the API in just a few minutes. This guide will walk you through making your first request.

First Request

Let's make a simple request to retrieve a list of content items. This endpoint doesn't require any parameters and will return the most recent content.

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.oscarrondon.com/v1/content

Response Format

All API responses follow a consistent JSON structure. Successful responses will include your requested data, while errors will include helpful error messages.

{
  "data": [
    {
      "id": "content_abc123",
      "title": "Getting Started with Technical Writing",
      "type": "blog",
      "author": "Oscar Rondon",
      "created_at": "2024-01-15T10:30:00Z",
      "status": "published"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 10,
    "offset": 0,
    "has_more": true
  },
  "meta": {
    "request_id": "req_xyz789",
    "response_time": "45ms"
  }
}

Now you're ready to explore the full API! Check out the API Reference for detailed endpoint documentation.