Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API key not always required #301

Merged
merged 2 commits into from
Jul 15, 2024
Merged

API key not always required #301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da6c681
API key not always required
nealmcb Jul 13, 2024
53a3a5e
Fix tag
nealmcb Jul 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions net/templates/api_help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h2>API</h2>
{% block content %}
<h2>About the API</h2>
<p>
Astrometry.net allows you to access parts of the service through a JSON API.
Astrometry.net allows you to access most parts of the service through a JSON API.
This API allows you to upload images, check job and submission statuses, and
retrieve all those useful bits of data from successfully calibrated fields -
all programmatically. This means that it's easy to write a script to upload
Expand All @@ -22,7 +22,13 @@ <h2>About the API</h2>
</p>
<h2>Getting Started</h2>
<p>
Before you can start using the API, you need to grab an <u>API key</u>.
Many API calls to retrieve information about existing images can be made
without permission. For example, you can retrieve the list of annotated
objects in an image via
{% url 'api/jobs/JOBID/annotations' %}.
</p>
<p>
If you want to modify data on the site, you need to grab an <u>API key</u> first.
This is a randomly generated string tied to your user account; everything
you do using the API will be through your account on the Astrometry.net
web service (e.g. any API uploads will show up on your web profile).
Expand Down
Loading