API Documentation

Everything you need to integrate product updates into your app.

Quick Start

1. Get your API key from the dashboard

2. Make a request to fetch your updates:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://businessyatch.com/api/v1/updates

Authentication

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer by_live_xxxxxxxxxxxx

Endpoints

GET/api/v1/updates

Fetch all your published updates.

Query Parameters

typeFilter by type: changelog, notification, product_update

limitNumber of results (default: 10, max: 100)

pagePage number for pagination

Response

{
  "updates": [
    {
      "id": "abc123",
      "type": "changelog",
      "title": "Dark mode is here!",
      "content": "We shipped dark mode...",
      "createdAt": "2024-12-21T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1
  }
}

Code Examples

JavaScript / TypeScript

const response = await fetch('https://businessyatch.com/api/v1/updates', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data.updates);

React Hook

function useUpdates() {
  const [updates, setUpdates] = useState([]);
  
  useEffect(() => {
    fetch('https://businessyatch.com/api/v1/updates', {
      headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
    })
      .then(res => res.json())
      .then(data => setUpdates(data.updates));
  }, []);
  
  return updates;
}

Rate Limits

Free tier: 1000 requests per day. Need more? Contact us.

Need help? Email us at [email protected]