Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.
BranchesTags

Repository files navigation

OpenAPIClient-php

Getting Started

Requirements

  • an account with the credentials;
    • e-mail address
    • password

Signing In

  1. Use the Sign-In endpoint to obtain a bearer token.
  • open the 'authorize' of the swagger and paste the bearer-token here
  • note: the authorization is persisted in the swagger but eventually the token will expire
  1. Use the user/me/companies endpoint to find out which company_ids are associated with the account
  2. Validate by using, for example, the Companies endpoint (GET)
  • fill the company-id

Resources

Check out support.sundata.nl to access our knowledge base. This contains articles about the credentials that are needed for creating a meter.

Changelog

This API uses semantic versioning. In short; with any breaking change we'll increase the first number of the version.

  • v1.6.0
    • Adds the plant-tags endpoints, for attaching and detaching tags
  • v2.0.0
    • Attaching tags and companies during plant creation or updating is no longer supported. These must now be attached using the plant-tags and plant-companies endpoints.
  • v2.1.0
    • Added yield endpoints for company, plant and meter.
  • v2.2.0
    • Added driver-account- and credentials-composition endpoints. You can find these under the tag: Creating a meter (also new).
    • Added the option the create a meter using credential-fields instead of reference_identifier. Using the reference_identifier is still supported for now.
  • v2.3.0
    • Added Plant time_zone property
  • v3.0.0
    • BREAKING Removed /companies/{company_id}/inbound-drivers and /companies/{company_id}/visible-inbound-drivers.
    • Added /companies/{company_id}/visible-driver-accounts. Note; /companies/{company_id}/driver-accounts was already available.
    • Fixed typo in documentation and rephrased documentation regarding driver_accounts.
    • Update docs on updating a meter.
  • v3.0.1
    • Added links in this documentation to support.sundata.nl, specifically for create meters.
  • v3.1.0
    • Added /utilities/validate/credentials. This can be useful when creating meters.
    • All fields are now optional when updating a meter.
    • These fields are now completely ignored when updating a meter (instead of returning 4XX); reference_identifier, inbound_driver, inbound_driver_id.
  • v4.0.0
    • Removed reference_identifier from responses (e.g. update meter and index meters)
    • Removed inbound_driver_id from responses
  • v4.0.1 and v4.0.2
    • fixes formatting around documentation of credential-compositions
  • v5.0.0 Scheduled January 2025 (move up from v4.0.0)
    • P90 will no longer be supported anywhere in this API. This affects creating, updating, and retrieving a meter. Any P90 fields will be removed from the response, and any P90 fields in requests will be ignored.
    • All weather_station_id fields will be removed from the responses.

Upcoming Changes

January 2025: P90 removal

P90 will no longer be supported anywhere in this API. This affects creating, updating, and retrieving a meter. Any P90 fields will be removed from the response, and any P90 fields in requests will be ignored.

January 2025: weather_station_id removal

All weather_station_id fields will be removed from the responses.

For more information, please visit https://www.sundata.nl.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/frittsnl/sundata-metropolis-client-php.git"
    }
  ],
  "require": {
    "frittsnl/sundata-metropolis-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: BearerAuth
$config = SunDataMetropolisClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new SunDataMetropolisClient\Api\ChildCompaniesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 56; // int | The id of the company
$child_company_id = 56; // int | The id of the child company

try {
    $result = $apiInstance->getAllCustomFieldTypesOfChildCompany($company_id, $child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChildCompaniesApi->getAllCustomFieldTypesOfChildCompany: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to /api/v0

Class Method HTTP request Description
ChildCompaniesApi getAllCustomFieldTypesOfChildCompany GET /companies/{company_id}/children/{child_company_id}/plant-custom-field-types Get all custom field types linked to the child company
ChildCompaniesApi getChildCompaniesTags GET /companies/{company_id}/children/tags Get Child Companies Tags
ChildCompaniesApi getCompanyChildCompanies GET /companies/{company_id}/children Get Company Child Companies
ChildCompaniesApi linkChildToCustomFieldType PUT /companies/{company_id}/children/{child_company_id}/plant-custom-field-types/{custom_field_id} Link a child company to a plant custom field type
ChildCompaniesApi unlinkChildFromCustomFieldType DELETE /companies/{company_id}/children/{child_company_id}/plant-custom-field-types/{custom_field_id} Unlink a child company from a plant custom field type
CompaniesApi getCompany GET /companies/{company_id} Get a company
CompaniesApi getCompanyTags GET /companies/{company_id}/tags Get Company Tags
CompaniesApi getCompanyTicket GET /companies/{company_id}/tickets/{ticket_id} Get a ticket of a company
CompaniesApi getCompanyTickets GET /companies/{company_id}/tickets Get all tickets of a company
CompaniesApi getCompanyYield GET /companies/{company_id}/yield Get the yield for a company over a period
CompaniesApi getCustomFieldTypes GET /companies/{company_id}/plant-custom-field-types Get Company Custom Field types
CompaniesApi getDriverAccounts_0 GET /companies/{company_id}/driver-accounts Get all driver accounts that are available to the company.
CompaniesApi getVisibleDriverAccounts GET /companies/{company_id}/visible-driver-accounts Get all driver accounts that are VISIBLE to the company.
ContactsApi createPlantContact POST /companies/{company_id}/plants/{plant_id}/contacts Create a new plant contact
ContactsApi deletePlantContact DELETE /companies/{company_id}/plants/{plant_id}/contacts/{contact_id} Delete a plant contact
ContactsApi getPlantContact GET /companies/{company_id}/plants/{plant_id}/contacts/{contact_id} Get a single plant contact
ContactsApi getPlantContacts GET /companies/{company_id}/plants/{plant_id}/contacts Get all contacts for a plant
ContactsApi updatePlantContact PUT /companies/{company_id}/plants/{plant_id}/contacts/{contact_id} Update a plant contact
CreatingAMeterApi createMeter_0 POST /companies/{company_id}/plants/{plant_id}/meters Create Plant Meter
CreatingAMeterApi getCredentialCompositions GET /companies/{company_id}/driver-accounts/{account_name}/credential-compositions Get the allowed compositions of credentials for a given driver accounts
CreatingAMeterApi getDriverAccounts GET /companies/{company_id}/driver-accounts Get all driver accounts that are available to the company.
CreatingAMeterApi validateCredentials PUT /utilities/validate/credentials Validate whether credentials are valid.
CustomFieldsApi createPlantCustomFields POST /companies/{company_id}/plants/{plant_id}/custom-fields Create Plant Custom Fields
CustomFieldsApi deletePlantCustomField DELETE /companies/{company_id}/plants/{plant_id}/custom-fields/{custom_field_id} Delete plant custom field
CustomFieldsApi getPlantCustomField GET /companies/{company_id}/plants/{plant_id}/custom-fields/{custom_field_id} Get a plant custom field
CustomFieldsApi getPlantCustomFields GET /companies/{company_id}/plants/{plant_id}/custom-fields Get Plant Custom Fields
CustomFieldsApi updatePlantCustomField PUT /companies/{company_id}/plants/{plant_id}/custom-fields/{custom_field_id} Update plant custom field
MetersApi createMeter POST /companies/{company_id}/plants/{plant_id}/meters Create Plant Meter
MetersApi getMeterById GET /companies/{company_id}/plants/{plant_id}/meters/{meter_id} Get Meter by ID
MetersApi getMeterYield GET /companies/{company_id}/plants/{plant_id}/meters/{meter_id}/yield Get the yield for a meter over a period
MetersApi updateMeter PUT /companies/{company_id}/plants/{plant_id}/meters/{meter_id} Update Meter
PlantsApi attachChildCompany PUT /companies/{company_id}/plants/{plant_id}/companies/{child_company_id} Attach a child company to the plant
PlantsApi attachTag PUT /companies/{company_id}/plants/{plant_id}/tags/{tag_id} Attach a tag to the plant
PlantsApi createPlant POST /companies/{company_id}/plants Create Plant
PlantsApi detachChildCompany DELETE /companies/{company_id}/plants/{plant_id}/companies/{child_company_id} Detach a child company from the plant
PlantsApi detachTag DELETE /companies/{company_id}/plants/{plant_id}/tags/{tag_id} Detach a tag from the plant
PlantsApi getPlantById GET /companies/{company_id}/plants/{plant_id} Plant details
PlantsApi getPlantCompanies GET /companies/{company_id}/plants/{plant_id}/companies Get all companies attached to the plant
PlantsApi getPlantTags GET /companies/{company_id}/plants/{plant_id}/tags Get all tags attached to the plant
PlantsApi getPlantYield GET /companies/{company_id}/plants/{plant_id}/yield Get the yield for a plant over a period
PlantsApi getPlants GET /companies/{company_id}/plants Plants
PlantsApi updatePlant PUT /companies/{company_id}/plants/{plant_id} Update Plant
SignInApi signIn POST /sign-in Obtain a bearer token and sign-in
TicketsApi closeTicket PUT /companies/{company_id}/plants/{plant_id}/tickets/{ticket_id}/close Close a ticket
TicketsApi createTicket POST /companies/{company_id}/plants/{plant_id}/tickets Create a new ticket
TicketsApi deleteTicket DELETE /companies/{company_id}/plants/{plant_id}/tickets/{ticket_id} Delete a ticket
TicketsApi getTicket GET /companies/{company_id}/plants/{plant_id}/tickets/{ticket_id} Get a ticket
TicketsApi getTickets GET /companies/{company_id}/plants/{plant_id}/tickets Get all tickets for a plant
TicketsApi openTicket PUT /companies/{company_id}/plants/{plant_id}/tickets/{ticket_id}/open Open a ticket
TicketsApi updateTicket PUT /companies/{company_id}/plants/{plant_id}/tickets/{ticket_id} Update a ticket
UserApi getUserMe GET /users/me Information about the current account
UserApi getUserMeCompanies GET /users/me/companies List the companies associated with your account

Models

Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

admin@sundata.nl

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 4.0.2
    • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages