https://github.com/virtomize/i-doit-go-api
go api library
https://github.com/virtomize/i-doit-go-api
api-client client-library cmdb-api-client golang-library idoit
Last synced: about 2 months ago
JSON representation
go api library
- Host: GitHub
- URL: https://github.com/virtomize/i-doit-go-api
- Owner: Virtomize
- License: mit
- Created: 2017-03-03T08:25:31.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-16T13:06:19.000Z (almost 4 years ago)
- Last Synced: 2025-03-25T11:11:30.715Z (2 months ago)
- Topics: api-client, client-library, cmdb-api-client, golang-library, idoit
- Language: Go
- Size: 81.1 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# i-doit-go-api/goidoit
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VBXHBYFU44T5W&source=url)
[](https://godoc.org/github.com/virtomize/i-doit-go-api)
[](https://goreportcard.com/report/github.com/virtomize/i-doit-go-api)
[](https://github.com/virtomize/i-doit-go-api/blob/master/LICENSE)
[](https://travis-ci.com/virtomize/i-doit-go-api)
[](https://magefile.org)
is an [I-doit](https://www.i-doit.com/) API client implementation written in [GOLANG](https://golang.org).
Its focused on simplicity to create easy writable code for your projects.
the package supports:
- Login
- Requests
- Searching
- Getting object information by id, id slice, string or custom field
- creating, altering, deleting, archiving, quickpurging objects
- reports
- categories (only parts implemented) (wip)
- object\_type\_categories
- dialog
Other types of requests like
- object\_types (coming soon)
- object\_type\_groups (coming soon)
- objects\_by\_relation (coming soon)
- categories (category, category\_info) (wip)
- location\_tree
- workstation\_components
- logbook
- impact
are not implemented yet (and maybe never will) but can easily be implemented using the goidoit.Request function
there are some [advanced](https://github.com/virtomize/i-doit-go-api/blob/master/examples/advanced.go) [examples](https://github.com/virtomize/i-doit-go-api/blob/master/examples/advanced2.go) of how to do this.
There is also a second repo [i-doit-go-tools](https://github.com/virtomize/i-doit-go-tools) where you can find some more scripts for special use-cases that can be used as an
even more advanced example :P.
## Installation
If you already installed GO on your system and configured it properly than its simply:
```
go get github.com/virtomize/i-doit-go-api
```
If not follow [these instructions](https://golang.org/doc/install)
## Usage
### Simple example
```
package main
import (
"fmt"
"github.com/virtomize/i-doit-go-api"
)
func main() {
// create api object
a, _ := goidoit.NewAPI("https://example.com/src/jsonrpc.php", "yourapikey")
// or login using X-RPC-Auth (recommended)
// a, _ := goidoit.NewLogin("https://example.com/src/jsonrpc.php", "yourapikey", "username", "password")
// search for sth like test
s, _ := a.Search("test")
// thats it
fmt.Println(s)
}
```
### Advanced examples
There are more advanced [examples](https://github.com/virtomize/i-doit-go-api/tree/master/examples) documented in the repo for common use cases.
## Code Documentation
You find the full [code documentation here](https://godoc.org/github.com/virtomize/i-doit-go-api)
## Code Testing
This library uses [mage](https://magefile.org/) for testing and coverage.
After installing mage just run:
```
mage test
```
also code coverage in detail can be seen via browser by using
```
mage coverage
```
## Additional Informations
- [i-doit API documentation](https://kb.i-doit.com/pages/viewpage.action?pageId=37355644)
- [golang](https://golang.org/)
- [godoc](https://godoc.org/)
- [golang playground](https://play.golang.org/)
This project uses [sematic versioning](https://semver.org/).
## Other great client implementations
- Benjamin Heisigs [i-doit-api-client-php](https://github.com/bheisig/i-doit-api-client-php/)
- Dennis Stückens [i-doit-api-clients](https://bitbucket.org/dstuecken/i-doit-api-clients/)
Thanks for your code inspirations!
## Contribution
Thank you for participating to this project.
Please see our [Contribution Guidlines](https://github.com/virtomize/i-doit-go-api/blob/master/CONTRIBUTING.md) for more information.