-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
title: "Software Development Kits" | ||
slug: "sdk" | ||
subtitle: "" | ||
hidden: false | ||
createdAt: "Wed Jun 01 2022 23:44:11 GMT+0000 (Coordinated Universal Time)" | ||
updatedAt: "Tue Dec 12 2023 22:09:32 GMT+0000 (Coordinated Universal Time)" | ||
--- | ||
Chariot's API can be accessed via SDKs for several popular languages. | ||
The SDKs are generated from our OpenAPI 3 [specification](https://github.com/chariot-giving/chariot-openapi/blob/main/specs). | ||
The JSON specification may be helpful if you are looking to use a language we haven't implemented yet! | ||
|
||
Our APIs are stable but we're just getting started with these SDKs, | ||
so some things might change in future versions. | ||
If you find them useful or have feedback, [please let us know]((mailto:support@givechariot.com))! | ||
|
||
Using an SDK can speed up your integration by providing an implementation for pagination, serialization, timeouts, retries, and error handling. | ||
|
||
## Node | ||
|
||
Install our Node SDK with `npm` or `yarn`. | ||
The source is on [GitHub](https://github.com/chariot-giving/typescript-sdk). | ||
Request parameters, response bodies, and error details are all typed with Typescript. | ||
|
||
```sh | ||
$ npm install --save @chariot-giving/typescript-sdk | ||
# or | ||
$ yarn add @chariot-giving/typescript-sdk | ||
``` | ||
|
||
## More coming soon! | ||
|
||
Let us know if you'd like to be an early adopter or if there's another language we should support. |