README

Digitrack API

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/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@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 (JWT) authorization: bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\EventsApi(
    // 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
);
$create_event_input = new \OpenAPI\Client\Model\CreateEventInput(); // \OpenAPI\Client\Model\CreateEventInput

try {
    $result = $apiInstance->eventControllerAddEvent($create_event_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->eventControllerAddEvent: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request
EventsApi	eventControllerAddEvent	POST /events
EventsApi	eventControllerDeleteEvent	DELETE /events/{id}
OrderProductsApi	create	POST /orders/{orderId}/products
OrderProductsApi	delete	DELETE /orders/{orderId}/products/{id}
OrderProductsApi	update	PATCH /orders/{orderId}/products/{id}
OrdersApi	create	POST /orders
OrdersApi	delete	DELETE /orders/{id}
OrdersApi	get	GET /orders/{id}
OrdersApi	getByReference	GET /orders/by-reference/{reference}
OrdersApi	getByTrackingNumber	GET /orders/by-tracking-number/{trackingNumber}
OrdersApi	update	PATCH /orders/{id}

Models

Authorization

Authentication schemes defined for the API:

bearer

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

API version: 1.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

randock / digitrack-api-client

Maintainers

Details