Skip to content

Commit 5e5859c

Browse files
authored
Update README.md
1 parent ad8979a commit 5e5859c

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
# client-sdk-python
1+
<div align="center">
2+
<picture>
3+
<source srcset="https://user-images.githubusercontent.com/6267663/221800355-0995e4ad-a386-4943-a4c2-e620341a5155.svg" media="(prefers-color-scheme: dark)">
4+
<img src="https://user-images.githubusercontent.com/6267663/221800359-b7f7776c-a44f-4384-8dd0-d9f7d5caef7d.svg">
5+
</picture>
6+
<h1>Codat Python SDK</h1>
7+
<p><strong>The universal API for small business data</strong></p>
8+
<p>Codat solves the connectivity challenge for developers building the next generation of financial products for small businesses. We're experts in how your application interacts with the other software your customer use, so you can focus on what makes you superior.</p>
9+
<a href="https://docs.codat.io/using-the-api/overview"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=4c2cec&style=for-the-badge" /></a>
10+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
11+
</div>
12+
13+
## Authentication
14+
15+
Codat uses API keys to control access to the API.
16+
17+
You must keep the API key secret, so make sure it isn't available in publicly accessible areas, such as GitHub and client-side code. Codat recommends the API key is only inserted at release time, and the number of people at your organization with access to your API key is minimised.
18+
19+
Codat expects the API key to be included in all API requests to the server, Base64 encoded within an 'Authorization' header.
20+
21+
```bash
22+
Authorization: Basic YOUR_ENCODED_API_KEY
23+
```
24+
25+
### Getting your Authorization Header
26+
27+
To get your authorization header from the [Codat Portal](https://signup.codat.io/):
28+
29+
1. In the navigation bar, click **Developers > API keys**.
30+
2. In the **API Keys** section, copy your authorization header rather than the API key itself.
31+
32+
## Codat APIs
33+
34+
- [**/Common API**](https://github.com/codatio/client-sdk-go/tree/main/common) - Manage the building blocks of Codat, including companies, connections, and more.
35+
- [**/Accounting API**](https://github.com/codatio/client-sdk-go/tree/main/accounting) - Access standardized accounting data from our accounting integrations.
36+
- [**/Banking API**](https://github.com/codatio/client-sdk-go/tree/main/banking) - Access standardized banking data from our banking integrations.
37+
- [**/Commerce API**](https://github.com/codatio/client-sdk-go/tree/main/commerce) - Access standardized commerce data from our commerce integrations.
38+
- [**/Bank Feeds API**](https://github.com/codatio/client-sdk-go/tree/main/bankfeeds) - Set up bank feeds from accounts in your application to supported accounting platforms.
39+
- [**/Assess API**](https://github.com/codatio/client-sdk-go/tree/main/assess) - Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.
40+
- [**/Sync for Commerce API**](https://github.com/codatio/client-sdk-go/tree/main/synccommerce) - Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform.
41+
- [**/Sync for Expenses API**](https://github.com/codatio/client-sdk-go/tree/main/expenses) - Push expenses to accounting platforms.
42+
- [**/Files API**](https://github.com/codatio/client-sdk-go/tree/main/files) - Capture your SMB's business documents with our file upload functionality.

0 commit comments

Comments
 (0)