Skip to content

Commit d4b8287

Browse files
authored
Update readme (#182)
- Updated authentication mechanisms - Added section on protocols
1 parent 8f7696b commit d4b8287

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A Python SDK which provides easy access to Exabel APIs.
88
pip install exabel
99
```
1010

11-
or download from [PyPI](https://pypi.org/project/exabel/).
11+
or download from [PyPI](https://pypi.org/project/exabel).
1212

1313
The SDK requires Python 3.10 or later.
1414

@@ -32,11 +32,7 @@ Supported data sources are:
3232

3333
## Getting started
3434

35-
To use the SDK against the Data API, Analytics API or Management API, you need an API key provided by Exabel.
36-
37-
The Exabel Export API can be used by authenticating with username and password.
38-
The first time you run the script a web browser window is opened where you are asked to provide username and password. The script stores an access token in ``~/.exabel``, so you will not be asked again
39-
until the token expires.
35+
To use the SDK against, you need an API key or personal access token. This can be found in the Exabel app.
4036

4137
[Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk)
4238

@@ -67,3 +63,10 @@ The Exabel Analytics API can be used to manage derived signals and prediction mo
6763
The Exabel Management API can be used to manage the library on the Exabel Platform.
6864

6965
[Management API Developer guide](https://help.exabel.com/docs/management-api)
66+
67+
## Protocols
68+
69+
For efficiency, the SDK uses gRPC when communicating with the Data API, Analytics API,
70+
and Management API. The Export API is only available as a REST API.
71+
72+
gRPC uses HTTPS on server port 21443, while REST uses HTTPS on server port 443.

0 commit comments

Comments
 (0)