README.md 4.8 KB
Newer Older
1 2
# GLPI API Library for Java

Naylin Medina's avatar
Naylin Medina committed
3 4
![GLPI banner](https://user-images.githubusercontent.com/29282308/31666160-8ad74b1a-b34b-11e7-839b-043255af4f58.png)

Naylin's avatar
Naylin committed
5 6
[![License](https://img.shields.io/github/license/glpi-project/java-library-glpi.svg?&label=License)](https://github.com/glpi-project/java-library-glpi/blob/develop/LICENSE.md)
[![Follow twitter](https://img.shields.io/twitter/follow/GLPI_PROJECT.svg?style=social&label=Twitter&style=flat-square)](https://twitter.com/GLPI_PROJECT)
7
[![Project Status: WIP](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/)
Naylin's avatar
Naylin committed
8
[![Telegram Group](https://img.shields.io/badge/Telegram-Group-blue.svg)](https://t.me/glpien)
Naylin Medina's avatar
Naylin Medina committed
9
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
10
[![Greenkeeper badge](https://badges.greenkeeper.io/glpi-project/java-library-glpi.svg)](https://greenkeeper.io/)
Naylin Medina's avatar
Naylin Medina committed
11 12 13 14 15 16 17 18 19

GLPI (_Gestionnaire Libre de Parc Informatique_) is a free IT Asset Management, issue tracking system and service desk solution. This open source software is written in PHP.

It helps companies to manage their information system, since it's able to build an inventory of all the organization's assets and to manage administrative and financial tasks.

## Table of Contents

* [Synopsis](#synopsis)
* [Build Status](#build-status)
Naylin Medina's avatar
Naylin Medina committed
20
* [Installation](#installation)
21
* [Compatibility matrix](#matrix)
Naylin Medina's avatar
Naylin Medina committed
22 23 24 25 26 27 28 29 30 31
* [Documentation](#documentation)
* [Versioning](#versioning)
* [Contact](#contact)
* [Contribute](#contribute)
* [Copying](#copying)

## Synopsis

This library created in Java features several functionalities common to all GLPI APIs, for example:

Naylin's avatar
Naylin committed
32 33 34 35 36 37 38
* HTTP transport to APIs.
* Error handling
* Authentication
* JSON parsing
* Custom Item Types
* Media download/upload
* Batching.
Naylin Medina's avatar
Naylin Medina committed
39

Naylin's avatar
Naylin committed
40
You will be able to call all the methods that belong to the [GLPI REST API](https://github.com/glpi-project/glpi/blob/master/apirest.md), for more information visit the [project's website](https://glpi-project.github.io/java-library-glpi/).
Naylin Medina's avatar
Naylin Medina committed
41 42 43 44 45

## Build Status

|**Release channel**|Beta Channel|
|:---:|:---:|
Naylin's avatar
Naylin committed
46
|[![Circle CI build](https://circleci.com/gh/glpi-project/java-library-glpi/tree/master.svg?style=svg)](https://circleci.com/gh/glpi-project/java-library-glpi/tree/master)|[![Circle CI build](https://circleci.com/gh/glpi-project/java-library-glpi/tree/develop.svg?style=svg)](https://circleci.com/gh/glpi-project/java-library-glpi/tree/develop)|
Naylin Medina's avatar
Naylin Medina committed
47

Naylin Medina's avatar
Naylin Medina committed
48 49 50 51
## Installation

### External Library Manager

52
#### Maven
Naylin Medina's avatar
Naylin Medina committed
53 54 55 56 57 58 59 60 61 62 63 64 65

```xml
<dependency>
  <groupId>org.glpi</groupId>
  <artifactId>api</artifactId>
  <version>1.0.0</version>
  <type>pom</type>
</dependency>
```

#### Gradle

```groovy
66
compile 'org.glpi:api:1.0.0@jar'
Naylin Medina's avatar
Naylin Medina committed
67 68 69 70 71
```

#### Apache Ivy

```
72
<dependency org='org.glpi' name='api' rev='1.0.0'>
Naylin Medina's avatar
Naylin Medina committed
73 74 75 76
  <artifact name='api' ext='pom' ></artifact>
</dependency>
```

77
You can also find us on [**Bintray repository**](https://bintray.com/glpi-project/maven-repository/java-library-glpi).
Naylin Medina's avatar
Naylin Medina committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92

### Manually

In your ```setting.gradle``` add the following line:

```groovy
include ':my-project', ':java-library-glpi'
```

And in your ```build.gradle``` add:

```groovy
implementation project(':java-library-glpi')
```

93 94
## Matrix

Naylin Medina's avatar
Naylin Medina committed
95 96 97
|**GLPI Version**|9.1|9.2|9.3|
|:----|----|----|----|
|**GLPI API Client**||||
98

Naylin Medina's avatar
Naylin Medina committed
99 100
## Documentation

Naylin's avatar
Naylin committed
101
We maintain a detailed documentation of the project on the [website](https://glpi-project.github.io/java-library-glpi/).
Naylin Medina's avatar
Naylin Medina committed
102 103 104

## Versioning

Naylin's avatar
Naylin committed
105
In order to provide transparency on our release cycle and to maintain backward compatibility, GLPI is maintained under [the Semantic Versioning guidelines](http://semver.org/). We are committed to following and complying with the rules, the best we can.
Naylin Medina's avatar
Naylin Medina committed
106

Naylin's avatar
Naylin committed
107
See [the tags section of our GitHub project](https://github.com/glpi-project/java-library-glpi/tags) for changelogs for each release version. Release announcement posts on [the official Teclib' blog](http://www.teclib-edition.com/en/communities/blog-posts/) contain summaries of the most noteworthy changes made in each release.
Naylin Medina's avatar
Naylin Medina committed
108 109 110

## Contact

Naylin's avatar
Naylin committed
111
For notices about major changes and general discussion of GLPI development, subscribe to the [/r/glpi](http://www.reddit.com/r/glpi) subreddit.
112
You can also chat with us via IRC in [#GLPI on freenode](http://webchat.freenode.net/?channels=GLPI) or [@glpien on Telegram](https://t.me/glpien).
Naylin Medina's avatar
Naylin Medina committed
113 114 115 116

## Contribute

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our
Naylin's avatar
Naylin committed
117
guidelines for [contributing](./CONTRIBUTING.md) and then check out one of our issues in the [Issues Dashboard](https://github.com/glpi-project/java-library-glpi/issues).
Naylin Medina's avatar
Naylin Medina committed
118 119 120 121 122 123

## Copying

* **Code**: you can redistribute it and/or modify
    it under the terms of the GNU General Public License ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html)).
* **Documentation**: released under Attribution 4.0 International ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)).