Skip to content

Add Authentication section at the top of the API page #30

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

Merged
joshuamzm merged 4 commits into from
Oct 12, 2023
Merged

Add Authentication section at the top of the API page #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d885b1b
Add Authentication section at the top of the API page
joshuamzm Oct 11, 2023
74c578a
Manually add sphinx-rtd-theme dependency
joshuamzm Oct 11, 2023
8de74f9
Pin dependency versions
joshuamzm Oct 11, 2023
63ef399
Improve formatting
joshuamzm Oct 11, 2023
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
3 changes: 2 additions & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Extra packages

sphinx-copybutton # 2023-05-03 - Joshua: Added for easy code blocks copying
sphinx-copybutton == 0.5.2 # 2023-05-03 - Joshua: Added for easy code blocks copying
sphinx-rtd-theme == 1.3.0 # 2023-10-11 - Joshua: For some reason, RTD automatic builds won't include this package
28 changes: 25 additions & 3 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,32 @@ API
Overview
--------

.. _authentication:
.. _authentication:

Authentication
--------------

All requests to the Modeling API must include authentication credentials.

API access tokens are applied to your requests to protect sensitive PII and are compliant with common privacy and security standards.

A valid token must be included as part of the HTTP ``Authorization`` header, using the `bearer` HTTP authorization scheme. The value of the header will be ``Bearer <token>``, where you replace <token> with a valid token. Valid tokens will be provided to established customers of the API. It is planned to add the ability to rotate tokens and set expiration dates in future releases.

.. code-block::

Authorization: Bearer <token>


Here is an example using cURL:

.. code-block:: shell

curl -v 'https://api.radiantlabs.co/v1/timelines' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{"addressFull":"501 RANDALL RD, BALLSTON SPA, NY 12020"}' \
--compressed

Authentication
--------------

.. _endpoints:

Expand Down