RESTful API

Every request requires a valid authentication via HTTP-basic authentication (RFC 2617). You will get a valid user by the system administrator.

In this documentation, you can test every REST-route live. By clicking the "Test"-Button, a real request will be send to this server. You can see request and response. To enable this feature, you need to authorize with your real login:

All routes must be appended to the rest-server-url:

rest

POST
/rest/server/dev

icinga

PUT
/icinga/proxy/objects/services/:service
GET
/icinga/validator/:test
führt den mit :test übermittelten system-test aus

currencies

GET
/currencies
Will give you a list of all currencies.

price

GET
/price
You can use this route to request the prices for a shipment.

quotes

POST
/quotes
This can create a new quote. You will get an URL, where your user can place an order from the quote.

orders

GET
/orders/search
Searches for any orders. You can use different parameter to search for.
GET
/orders/:id
Use this route to get details about an order.

shops

GET
/shops/:id/countries
will return a list of valid countries this shop can ship to.
GET
/shops/:id/zipcodes
will return a list of valid zipcodes (per country) this shop can ship to.

webapp

GET
/webapp/notifications
allgemeine route zum longpolling
DELETE
/webapp/notifications/:id

eav

GET
/eav/attributeset/:identifier/attributes
GET
/eav/attributesets
GET
/eav/types
GET
/eav/types/:id/attributesets
GET
/eav/attributes/:identifier

erp

GET
/erp/efforts
GET
/erp/employees
GET
/erp/employees/:id
GET
/erp/employees/available_users
GET
/erp/announcements

crm

GET
/crm/contact

user

GET
/user
GET
/user/:id

packages

GET
/packages/scopes

system

GET
/system/info
GET
/system/code/reflection

access

GET
/access
gives you information about your current access.