Skip to content

Commit

Permalink
add sdk to api docs (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
magaldima authored Aug 19, 2024
1 parent ea4395a commit f3b8112
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
2 changes: 2 additions & 0 deletions fern/versions/v1/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ navigation:
path: ./pages/api-backend/errors-1.mdx
- page: Postman
path: ./pages/api-backend/postman.mdx
- page: Software Development Kits
path: ./pages/api-backend/sdk-1.mdx
- page: Webhooks and Events
path: ./pages/api-backend/webhooks-and-events.mdx
- api: API Reference
Expand Down
33 changes: 33 additions & 0 deletions fern/versions/v1/pages/api-backend/sdk-1.mdx
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.

0 comments on commit f3b8112

Please sign in to comment.