diff --git a/docs/requirements.txt b/docs/requirements.txt index d0c9eda..1f7a8e9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ # Extra packages -sphinx-copybutton # 2023-05-03 - Joshua: Added for easy code blocks copying \ No newline at end of file +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 diff --git a/docs/source/api.rst b/docs/source/api.rst index f6e7b87..3552a56 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -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 ``, where you replace 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 + + +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 ' \ + --data-raw '{"addressFull":"501 RANDALL RD, BALLSTON SPA, NY 12020"}' \ + --compressed - Authentication - -------------- .. _endpoints: