simplyadmire/zaaksysteem

Zaaksysteem API Client

2.1.0 2017-05-06 21:13 UTC

This package is auto-updated.

Last update: 2024-10-10 07:03:17 UTC


README

Build Status Code Climate Test Coverage

Latest Stable Version Total Downloads Latest Unstable Version License

This package is a PHP based client for Zaaksysteem (http://zaaksysteem.nl/). The client is standalone, meaning it does not depend on any PHP framework. Implementations for frameworks like Flow are planned and will be released as separate packages.

Usage

use SimplyAdmire\Zaaksysteem\V1\Configuration;
use SimplyAdmire\Zaaksysteem\V1\Client;
use SimplyAdmire\Zaaksysteem\V1\Domain\Repository\CaseTypeRepository;

$configuration = new Configuration([
    'username' => '<username>',
    'apiBaseUrl' => '<api base url excluding version prefix>',
    'apiKey' => '<api key>'
]);

$client = new Client($configuration);
$repository = new CaseTypeRepository($client);

$caseTypes = $repository->findAll();

Supported API's

Object

Manual: https://mintlab.zaaksysteem.nl/man/Zaaksysteem::Manual::API::Object.

For this API you have to configure an "Extern Koppelprofiel" in your Zaaksysteem instance.

Implemented methods:

  • get
  • list

V1

Manual: https://mintlab.zaaksysteem.nl/man/Zaaksysteem::Manual::API::V1.

For this API you have to configure an "Zaaksysteem API" in your Zaaksysteem instance.

Below you can find the implemented methods per API:

Case

  • get
  • list
  • create
  • update
  • transition
  • prepare file

Case\Document

  • get
  • list
  • download file

Case\CaseType

  • get
  • list

ControlPanel

  • get
  • list
  • create
  • update

ControlPanel\Host

  • get
  • list
  • create
  • update

ControlPanel\Instance

  • get
  • list
  • create
  • update

Case\Subject

  • create

Release history

  • Next release
    • Breaking change: api id is no longer part of the api base url
  • 1.0.1 Bugfix release
  • 1.0.0 Initial release