mirror of
https://github.com/dgtlmoon/changedetection.io.git
synced 2025-10-30 06:07:50 +00:00
8379fdb1f8
Some checks failed
Build and push containers / metadata (push) Has been cancelled
Build and push containers / build-push-containers (push) Has been cancelled
Publish Python 🐍distribution 📦 to PyPI and TestPyPI / Build distribution 📦 (push) Has been cancelled
Publish Python 🐍distribution 📦 to PyPI and TestPyPI / Test the built 📦 package works basically. (push) Has been cancelled
Publish Python 🐍distribution 📦 to PyPI and TestPyPI / Publish Python 🐍 distribution 📦 to PyPI (push) Has been cancelled
ChangeDetection.io App Test / lint-code (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-10 (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-11 (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-12 (push) Has been cancelled
ChangeDetection.io App Test / test-application-3-13 (push) Has been cancelled
27 lines
1.5 KiB
HTML
27 lines
1.5 KiB
HTML
<div class="introduction-content">
|
|
<h3>ChangeDetection.io, Web page monitoring and notifications API</h3>
|
|
<p>REST API for managing Page watches, Group tags, and Notifications.</p>
|
|
|
|
<p>changedetection.io can be driven by its built in simple API, in the examples below you will also find <code>curl</code> command line examples to help you.</p>
|
|
|
|
<p>
|
|
<h5>Where to find my API key?</h5>
|
|
The API key can be easily found under the <strong>SETTINGS</strong> then <strong>API</strong> tab of changedetection.io dashboard.<br>
|
|
Simply click the API key to automatically copy it to your clipboard.<br><br>
|
|
<img src="where-to-get-api-key.jpeg" alt="Where to find the API key" title="Where to find the API key" style="max-width: 80%"/>
|
|
</p>
|
|
|
|
<p>
|
|
<h5>Connection URL</h5>
|
|
The API can be found at <code>/api/v1/</code>, so for example if you run changedetection.io locally on port 5000, then URL would be
|
|
<code>http://localhost:5000/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history</code>.<br><br>
|
|
If you are using the hosted/subscription version of changedetection.io, then the URL is based on your login URL, for example.<br>
|
|
<code>https://<your login url>/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history</code>
|
|
</p>
|
|
<p>
|
|
<h5>Authentication</h5>
|
|
Almost all API requests require some authentication, this is provided as an <strong>API Key</strong> in the header of the HTTP request.<br><br>
|
|
For example;
|
|
<br><code>x-api-key: YOUR_API_KEY</code><br>
|
|
</p>
|
|
</div> |