Skip to content

Commit b45a3ed

Browse files
authored
Devexp 1501 python direct access to sdk api reference from readme (#6)
* Update README with improved documentation
1 parent 32f54b4 commit b45a3ed

1 file changed

Lines changed: 19 additions & 11 deletions

File tree

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ Here you'll find documentation related to the Sinch Python SDK, including how to
77

88
To use Sinch services, you'll need a Sinch account and access keys. You can sign up for an account and create access keys at [dashboard.sinch.com](https://dashboard.sinch.com).
99

10-
For more information on the SDK, refer to the dedicated [Python SDK documentation](https://developers.sinch.com/docs/sdks/python) section, and for the Sinch APIs on which this SDK is based, refer to the official [developer documentation portal](https://developers.sinch.com).
11-
1210

1311
## Table of contents:
1412

1513
- [Prerequisites](#prerequisites)
14+
- [Documentation](#documentation)
1615
- [Installation](#installation)
1716
- [Supported APIs](#supported-apis)
1817
- [Getting started](#getting-started)
@@ -35,6 +34,15 @@ For more information on the SDK, refer to the dedicated [Python SDK documentatio
3534
> **Warning**:
3635
> This SDK is intended for server-side (backend) use only. Do not use it in front-end or client-side applications (web, mobile, or desktop), regardless of language or framework. Doing so can expose your Sinch credentials to end-users.
3736
37+
38+
## Documentation
39+
40+
For more information on the SDK, refer to the dedicated [Python SDK documentation](https://developers.sinch.com/docs/sdks/python).
41+
42+
For the SDK's programmatic API surface, see the online [SDK reference](https://developers.sinch.com/sdk/sinch-sdk-python/latest).
43+
44+
For broader Sinch product documentation, including the underlying REST APIs, visit the official [Sinch developer portal](https://developers.sinch.com/).
45+
3846
## Installation
3947

4048
Run the following command to install the SDK:
@@ -106,7 +114,7 @@ event = sinch_events.parse_event(raw_body, headers)
106114

107115
`SINCH_EVENT_SECRET` is optional and set per app in the [Conversation dashboard](https://dashboard.sinch.com/convapi/apps). `parse_event` works without validating the request, but then its origin can't be verified, so calling `validate_authentication_header` (which returns `True`/`False`) is recommended in production.
108116

109-
You can find a complete example in [examples/sinch_events/conversation_api](./examples/sinch_events/conversation_api).
117+
You can find a complete example in [examples/sinch_events/conversation_api](https://github.com/sinch/sinch-sdk-python/blob/main/examples/sinch_events/conversation_api).
110118

111119
### SMS API
112120

@@ -163,7 +171,7 @@ event = sinch_events.parse_event(raw_body, headers)
163171

164172
Signature authentication for SMS events must be enabled for your account by your account manager; until then the signature headers are absent and `parse_event` can be used on its own. See the [SMS events documentation](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Webhooks/#tag/Webhooks/section/Callbacks).
165173

166-
You can find a complete example in [examples/sinch_events/sms_api](./examples/sinch_events/sms_api).
174+
You can find a complete example in [examples/sinch_events/sms_api](https://github.com/sinch/sinch-sdk-python/blob/main/examples/sinch_events/sms_api).
167175

168176
### Numbers API
169177

@@ -181,7 +189,7 @@ event = sinch_events.parse_event(raw_body, headers)
181189

182190
`SINCH_EVENT_SECRET` is the value configured on the Event Destination. `parse_event` works without validating the request, but then its origin can't be verified, so calling `validate_authentication_header` is recommended in production.
183191

184-
You can find a complete example in [examples/sinch_events/numbers_api](./examples/sinch_events/numbers_api).
192+
You can find a complete example in [examples/sinch_events/numbers_api](https://github.com/sinch/sinch-sdk-python/blob/main/examples/sinch_events/numbers_api).
185193

186194
### Number Lookup API
187195

@@ -313,20 +321,20 @@ The SDK relies on the following third-party dependencies:
313321
## Examples
314322

315323
You can find:
316-
- a Python example of each request in the [examples/snippets](./examples/snippets) folder.
317-
- getting started guides for specific use cases in the [examples/getting-started](./examples/getting-started) folder.
318-
- server-side event handling examples in the [examples/sinch_events](./examples/sinch_events) folder.
324+
- a Python example of each request in the [examples/snippets](https://github.com/sinch/sinch-sdk-python/blob/main/examples/snippets) folder.
325+
- getting started guides for specific use cases in the [examples/getting-started](https://github.com/sinch/sinch-sdk-python/blob/main/examples/getting-started) folder.
326+
- server-side event handling examples in the [examples/sinch_events](https://github.com/sinch/sinch-sdk-python/blob/main/examples/sinch_events) folder.
319327

320328
## Changelog & Migration
321329

322-
For information about the latest changes in the SDK, please refer to the [CHANGELOG](CHANGELOG.md) file
323-
and the [MIGRATION_GUIDE](MIGRATION_GUIDE.md) for instructions on how to update your code when upgrading to a new major version of the SDK.
330+
For information about the latest changes in the SDK, please refer to the [CHANGELOG](https://github.com/sinch/sinch-sdk-python/blob/main/CHANGELOG.md) file
331+
and the [MIGRATION_GUIDE](https://github.com/sinch/sinch-sdk-python/blob/main/MIGRATION_GUIDE.md) for instructions on how to update your code when upgrading to a new major version of the SDK.
324332

325333
## License
326334

327335
This project is licensed under the Apache License.
328336

329-
See the [LICENSE](LICENSE) file for the license text.
337+
See the [LICENSE](https://github.com/sinch/sinch-sdk-python/blob/main/LICENSE) file for the license text.
330338

331339

332340
## Contact

0 commit comments

Comments
 (0)