Skip to content

Commit

Permalink
Merge pull request #499 from artoonie/update-readme
Browse files Browse the repository at this point in the history
improve readme
  • Loading branch information
artoonie authored Jul 23, 2024
2 parents 73c88a7 + 6561440 commit 4ef7c89
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ To get started with programmatic access to rcvis:

1. Create an account on RCVis
2. Email [email protected] to enable API access
3. Submit a POST request to [https://www.rcvis.com/api/auth/get-token](https://www.rcvis.com/api/auth/get-token) to obtain an API Key, e.g. `POST https://www.rcvis.com/api/auth/get-token {"username": "username", "password": "password"}`.
3. Submit a POST request to [https://www.rcvis.com/api/auth/get-token](https://www.rcvis.com/api/auth/get-token) to obtain an API Key, e.g. `curl -X POST https://www.rcvis.com/api/auth/get-token -d username=yourUserName -d password=yourAmazingPassword`

With your API key, you may access two endpoints:
1. [https://www.rcvis.com/api/visualizations/](https://www.rcvis.com/api/visualizations/) requires field `jsonFile` with the body of a valid summary JSON.
Expand Down

0 comments on commit 4ef7c89

Please sign in to comment.