From 6561440f35a30a10b9b9219682574a5c2d30adcc Mon Sep 17 00:00:00 2001 From: Armin Samii Date: Mon, 22 Jul 2024 22:31:20 -0400 Subject: [PATCH] improve readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c00dec8..e58f9d72 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ To get started with programmatic access to rcvis: 1. Create an account on RCVis 2. Email team@rcvis.com 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.