Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeplin/javascript-sdk
Zeplin API client for JavaScript
https://github.com/zeplin/javascript-sdk
javascript-sdk typescript-sdk zeplin zeplin-api zeplin-client zeplin-sdk
Last synced: 11 days ago
JSON representation
Zeplin API client for JavaScript
- Host: GitHub
- URL: https://github.com/zeplin/javascript-sdk
- Owner: zeplin
- Created: 2021-05-11T10:35:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T14:39:34.000Z (2 months ago)
- Last Synced: 2024-10-05T04:24:16.509Z (30 days ago)
- Topics: javascript-sdk, typescript-sdk, zeplin, zeplin-api, zeplin-client, zeplin-sdk
- Language: TypeScript
- Homepage: https://docs.zeplin.dev
- Size: 423 KB
- Stars: 6
- Watchers: 25
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zeplin JavaScript SDK
[](https://www.npmjs.com/package/@zeplin/sdk)
[](https://www.npmjs.com/package/@zeplin/sdk)
Official JavaScript interface to the [Zeplin API](https://docs.zeplin.dev). It works in both Node.js and web browser environments.
## Installation
```
npm install @zeplin/sdk
```
or
```
yarn add @zeplin/sdk
```
## Getting started
To get started with the SDK, you can create a personal access token from the web app under [Developer](https://app.zeplin.io/profile/developer) tab in your profile page.
You can use this token to make API calls for your own Zeplin account.
```js
import { ZeplinApi, Configuration } from "@zeplin/sdk";
const zeplinClient = new ZeplinApi(new Configuration({ accessToken: "ACCESS_TOKEN" }));
const me = await zeplinClient.getCurrentUser();
```
### OAuth
If you want to build an application for other Zeplin users, you can also create a Zeplin app the [profile page](https://app.zeplin.io/profile/developer).
Check out this [example](./examples/oauth-app) to see how you can implement an OAuth flow using the SDK.
## Usage
The SDK exposes Zeplin API endpoints as methods. These methods are grouped into namespace objects by the type of object they interact with.
For example:
```js
import { ZeplinApi, Configuration, ScreenNoteColorNameEnum } from "@zeplin/sdk";
const zeplinClient = new ZeplinApi(new Configuration({ accessToken: "ACCESS_TOKEN" }));
// Get colors in the styleguide
zeplinClient.colors.getStyleguideColors("STYLEGUIDE_ID");
// Add a note on the screen
zeplinClient.screens.createScreenNote("PROJECT_ID", "SCREEN_ID", {
content: "Çaylar filiz! :turkish_tea:",
position: { x: 0.1, y: 0.1 },
color: ScreenNoteColorNameEnum.DEEP_PURPLE
});
// Invite a member to the workspace
zeplinClient.organizations.inviteOrganizationMember("ORGANIZATION_ID", {
handle: "rooolan",
role: "editor"
});
```
Check out the [API documentation](https://docs.zeplin.dev/reference) for complete list of endpoints and groups.
## Examples
- [Command-line app using personal access token](./examples/cli-with-personal-access-token)
- [Simple OAuth application](./examples/oauth-app)
- [Publishing screens and screen versions](./examples/publishing-screens)
## License
The project is available as open source under the terms of the [MIT License](LICENSE).
## Need help?
Ping us at [email protected] for any feedback or questions. You can also find us in the [Zeplin Developer Slack](https://zpl.io/zeplin-dev-slack) group!