https://github.com/feedeo/jopify
:convenience_store: Shopify :coffee: Java Library
https://github.com/feedeo/jopify
Last synced: 11 days ago
JSON representation
:convenience_store: Shopify :coffee: Java Library
- Host: GitHub
- URL: https://github.com/feedeo/jopify
- Owner: feedeo
- License: mit
- Created: 2016-03-11T15:22:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-13T13:21:18.000Z (over 9 years ago)
- Last Synced: 2025-03-04T09:23:16.015Z (over 1 year ago)
- Language: Java
- Homepage: http://www.shopify.com
- Size: 175 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jopify: Shopify API Java Library
[![][travis img]][travis]
[![][release img]][release]
[![][license img]][license]
[![][codecov img]][codecov]
## Features
* __API call rate limiter__ - complies with a _leaky bucket_ algorithm with a _leak rate_ of 2 calls/second (no 429's coming your way :v:).
## Installation
Add `jopify` to your `dependencies` block in your `pom.xml`.
```xml
com.feedeo
jopify
0.2.1
```
## Usage :shipit:
Build a `ShopifySession` from an OAuth 2.0 access token and the shop name. Then instantiate the desired API service through `ShopifyService`.
```java
import com.feedeo.shopify.*;
String oAuth2AccessToken = "my-oauth2-access-token";
String shopName = "my-shop-name";
ShopifySession session = new ShopifySession.Builder()
.withOAuth2AccessToken(oAuth2AccessToken)
.withShopName(shopName)
.build();
ShopifyService shopifyService = new ShopifyService();
ShopService shopService = shopifyService.getService(session, ShopService.class);
try {
Shop shop = shopService.getShop();
} catch (ShopifyException e) {
e.printStackTrace();
}
```
## Limitations
As of now it only supports a limited number of API services.
* [Shop](https://docs.shopify.com/api/reference/shop) :white_check_mark:
* [Product](https://docs.shopify.com/api/reference/product) :white_check_mark:
## Documentation
See the [Javadoc](http://feedeo.github.io/jopify/javadoc/) for the library API.
## Reference
[Shopify API reference](https://docs.shopify.com/api/reference)
[travis]:https://travis-ci.org/feedeo/jopify
[travis img]:https://travis-ci.org/feedeo/jopify.svg?branch=master
[release]:https://github.com/feedeo/jopify/releases
[release img]:https://img.shields.io/github/release/feedeo/jopify.svg
[license]:LICENSE
[license img]:https://img.shields.io/badge/license-MIT-blue.svg
[codecov]:https://codecov.io/github/feedeo/jopify?branch=master
[codecov img]:https://codecov.io/github/feedeo/jopify/coverage.svg?branch=master