Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robinbraemer/cloudflareapi
The most complete and extensible Cloudflare API v4 client library for Java.
https://github.com/robinbraemer/cloudflareapi
api client cloudflare cloudflare-api dns java java-8 lib library oop
Last synced: 12 days ago
JSON representation
The most complete and extensible Cloudflare API v4 client library for Java.
- Host: GitHub
- URL: https://github.com/robinbraemer/cloudflareapi
- Owner: robinbraemer
- License: apache-2.0
- Created: 2018-02-20T14:55:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T02:10:53.000Z (about 1 month ago)
- Last Synced: 2024-10-12T03:49:46.040Z (26 days ago)
- Topics: api, client, cloudflare, cloudflare-api, dns, java, java-8, lib, library, oop
- Language: Java
- Homepage: https://api.cloudflare.com/
- Size: 162 KB
- Stars: 58
- Watchers: 3
- Forks: 23
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# The Cloudflare - API/Library for Java
[![Jitpack-Month][jitpack-month-img]][jitpack-url]
[![JitPack][jitpack-img]][jitpack-url]
[![Travis][travis-img]][travis-url]
[![License][license-img]][license-url]
This Cloudflare API/Library interacts with [Cloudflare's fast API v4](https://api.cloudflare.com/)
and allows you to access every single feature _(even if it isn't added yet)_ of Cloudflare's API faster and much easier!
To add a dependency on this Cloudflare-API/Library using Maven or Gradle use the following:
**Maven:**
```xml
com.github.robinbraemer
cloudflareapi
GIT_COMMIT_SHA
jitpack.io
https://jitpack.io
```
**Gradle:**
```
dependencies {
compile 'com.github.robinbraemer:cloudflareapi:'
}
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
## Features
- **easy to build cloudflare requests (builder pattern)**
- **able to access every corner of cloudflare's api**
- **parsing results as objects (object oriented representation)**
- **it is an extremely flexible api**
- **asynchronicity support**
- **token & key+email authentication support**
## Getting Started
First, you define the access object.
```java
String CF_API_TOKEN = "your_cloudflare_api_token";
CloudflareAccess cfAccess = new CloudflareAccess(CF_API_TOKEN);
```
Or use key+email authentication:
```java
String CF_API_KEY = "your_cloudflare_api_key";
String CF_EMAIL = "[email protected]";
CloudflareAccess cfAccess = new CloudflareAccess(CF_API_KEY, CF_EMAIL);
```
Then you can create cloudflare requests.
```java
CloudflareResponse> response =
new CloudflareRequest( Category.LIST_ZONES, cfAccess )
.asObjectList( Zone.class );
```
## Learn more about the Cloudflare - client library
- Check out our users' guide in the wiki, [Cloudflare - API/Library explained][wiki-url].
- There is a lot to discover about this api/library.
### Licensing
Licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
[releases-url]: https://github.com/robinbraemer/CloudflareAPI/releases
[wiki-url]: https://github.com/robinbraemer/CloudflareAPI/wiki
[travis-url]: https://travis-ci.org/robinbraemer/CloudflareAPI
[travis-img]: https://travis-ci.org/robinbraemer/CloudflareAPI.svg?branch=master
[jitpack-url]: https://jitpack.io/#robinbraemer/CloudflareAPI
[jitpack-img]: https://jitpack.io/v/robinbraemer/CloudflareAPI.svg
[jitpack-month-img]: https://jitpack.io/v/robinbraemer/CloudflareAPI/month.svg
[gitter-url]: https://gitter.im/CloudflareAPI/Lobby
[gitter-img]: https://badges.gitter.im/Join%20Chat.svg
[license-url]: https://github.com/robinbraemer/CloudflareAPI/blob/master/LICENSE
[license-img]: https://img.shields.io/badge/license-Apache_2.0-blue.svg?style=flat