Making Requests

Learn the basics of making API requests

All API requests follow RESTful conventions and use standard HTTP methods.

HTTP Methods

GET - Retrieve resources
POST - Create new resources
PUT - Update existing resources (replaces entire resource)
DELETE - Delete resources

Request Headers

All requests must include:

Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Important: Some endpoints use application/x-www-form-urlencoded instead of JSON. Check the endpoint documentation.

URL Structure

API endpoints follow this pattern:

https://your-site.webinone.com/api/v2/admin/{resource}

Query Parameters

Many endpoints support query parameters for filtering, sorting, and pagination:

Where - JSON filter expression
Order_By - Sort field (prefix with - for descending)
Limit - Maximum number of results
Offset - Number of results to skip

Common Patterns

List Resources

GET /api/v2/admin/snippets?Limit=50&Order_By=-Id

Get Single Resource

GET /api/v2/admin/snippets/{id}

Create Resource

POST /api/v2/admin/snippets
Body: {"Name": "Header", "Alias": "header", ...}

Update Resource

PUT /api/v2/admin/snippets/{id}
Body: {complete object with all fields}

Code Examples

# GET Request Example
curl -X GET https://your-site.webinone.com/api/v2/admin/snippets?Limit=10 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# POST Request Example
curl -X POST https://your-site.webinone.com/api/v2/admin/snippets \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Name": "Header",
    "Alias": "header",
    "Content": "...",
    "Enabled": true
  }'