Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 2.58 KB

README.md

File metadata and controls

91 lines (67 loc) · 2.58 KB

The Cloudflare - API/Library for Java

Travis JitPack Gitter License

This Cloudflare API/Library interacts with Cloudflare's fast API v4 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:

<dependency>
  <groupId>com.github.robinbraemer</groupId>
  <artifactId>cloudflareapi</artifactId>
  <version>1.3.2</version>
</dependency>
	
<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

Gradle:

dependencies {
  compile 'com.github.robinbraemer:cloudflareapi:1.3.2'
}

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

Getting Started

First, create an entry-point to use this api.

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.

CloudflareResponse<List<Zone>> response =
    new CloudflareRequest( Category.LIST_ZONES, cfAccess )
        .asObjectList( Zone.class );

Learn more about the Cloudflare - API/Library

Licensing

Licensed under the Apache License 2.0. See the LICENSE file for details.