JetractClient-php

Main API (Application Programming Interface) of Jetract E-Auction and E-Procurement solutions.
Property of INARTS YAZILIM BILISIM INSAAT SAN. VE TIC. A.Ş.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.9.8
• Package version: 0.9.8
• Documentation: https://jetract.com/docs/api/0.9.8
• Postman Documentation: https://documenter.getpostman.com/view/3494182/TzJybvJw

Requirements

PHP 7.2 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$apiInstance = new Swagger\Client\Api\AddressesApi(
    // 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
);
$user_id = "user_id_example"; // string | 
$company_id = "company_id_example"; // string | 
$x_api_key = "x_api_key_example"; // string | 

try {
    $result = $apiInstance->getAddresses($user_id, $company_id, $x_api_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressesApi->getAddresses: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://30fo61e8a3.execute-api.eu-west-1.amazonaws.com/Production

Class	Method	HTTP request	Description
AddressesApi	getAddresses	GET /addresses
AddressesApi	getCities	GET /addresses/cities
AddressesApi	newAddress	POST /addresses
AuctionsApi	deleteAuction	DELETE /auctions/{auctionID}
AuctionsApi	endAuction	POST /auctions/end/{auctionID}
AuctionsApi	getAuction	GET /auctions/{auctionID}
AuctionsApi	getAuctions	GET /auctions
AuctionsApi	newAuction	POST /auctions
AuctionsApi	publishAuction	POST /auctions/publish/{auctionID}
AuctionsApi	startAuction	POST /auctions/start/{auctionID}
AuctionsApi	updateAuction	PUT /auctions/{auctionID}
AuctionsAnnouncementsApi	getAnnouncements	GET /auctions/announcements/{auctionID}
AuctionsBiddersApi	addBidder	POST /auctions/bidders/{auctionID}
AuctionsBiddersApi	auctionsBiddersAgreementsResetAuctionIDPost	POST /auctions/bidders/agreements/reset/{auctionID}
AuctionsFilesApi	deleteAuctionFile	DELETE /auctions/files/{auctionID}
AuctionsFilesApi	newAuctionFile	POST /auctions/files/{auctionID}
AuctionsOffersApi	deleteOffer	DELETE /auctions/offers/{auctionID}
AuctionsReportsApi	getExcelReport	GET /auctions/reports/excel/{auctionID}
AuctionsStagesApi	deleteAuctionStage	DELETE /auctions/stages/{auctionID}
AuctionsStagesApi	endAuctionStage	POST /auctions/stages/end/{auctionID}
AuctionsStagesApi	newAuctionStage	POST /auctions/stages/{auctionID}
AuctionsStagesApi	startAuctionStage	POST /auctions/stages/start/{auctionID}
BiddersApi	deleteBidder	DELETE /bidders/{bidderID}
BiddersApi	getBidder	GET /bidders/{bidderID}
BiddersApi	getBidders	GET /bidders
BiddersApi	newBidder	POST /bidders
BiddersApi	updateBidder	PUT /bidders/{bidderID}
BiddersAuctionsApi	bidderAuctionsAuctionIDGet	GET /bidder/auctions/{auctionID}
BiddersAuctionsApi	bidderAuctionsGet	GET /bidder/auctions
BiddersBiddingApi	biddersBiddingPost	POST /bidders/bidding
BiddersGroupsApi	deleteBidderGroup	DELETE /bidders/groups/{groupID}
BiddersGroupsApi	getBidderGroup	GET /bidders/groups/{groupID}
BiddersGroupsApi	getBidderGroups	GET /bidders/groups
BiddersGroupsApi	newBidderGroup	POST /bidders/groups
BiddersGroupsApi	updateBidderGroup	PUT /bidders/groups/{groupID}
CategoriesApi	deleteCategory	DELETE /categories/{categoryID}
CategoriesApi	getCategories	GET /categories
CategoriesApi	getCategory	GET /categories/{categoryID}
CategoriesApi	newCategory	POST /categories
CategoriesApi	updateCategory	PUT /categories/{categoryID}
CountriesApi	getCountries	GET /addresses/countries
DefaultApi	rootGet	GET /
DefaultApi	updateAuctionParameters	PATCH /auctions/{auctionID}
DepartmentsApi	getDepartments	GET /departments
DepartmentsApi	newDepartment	POST /departments
FilesApi	download	GET /files/{fileID}
FilesApi	upload	POST /files
OrdersApi	getOrder	GET /orders/{orderID}
OrdersApi	getOrders	GET /orders
ProcurementRequestsApi	deleteProcurementRequest	DELETE /procurementrequests/{procurementRequestID}
ProcurementRequestsApi	getProcurementRequest	GET /procurementrequests/{procurementRequestID}
ProcurementRequestsApi	getProcurementRequests	GET /procurementrequests
ProcurementRequestsApi	newProcurementRequest	POST /procurementrequests
ProcurementUnitsApi	getUnits	GET /units

Documentation For Models

• AddressCityResponse
• AddressCountryResponse
• AddressNew
• AddressesResponse
• AuctionAddressResponse
• AuctionAnnouncementResponse
• AuctionAnnouncementsResponse
• AuctionAttachBidder
• AuctionAttachFiles
• AuctionBestBidderResponse
• AuctionBidderAgreementReset
• AuctionBidderGroupResponse
• AuctionBidderResponse
• AuctionConditionResponse
• AuctionDeleteFile
• AuctionDeleteOffer
• AuctionInformationResponse
• AuctionItemResponse
• AuctionNew
• AuctionNewResponse
• AuctionOfferItemResponse
• AuctionOfferResponse
• AuctionReportResponse
• AuctionResponse
• AuctionStageBidderResponse
• AuctionStageDelete
• AuctionStageEnd
• AuctionStageResponse
• AuctionUpdate
• AuctionUpdateParameters
• AuctionsInformationResponse
• AuctionsResponse
• BidderAuctionAnnouncementResponse
• BidderAuctionConditionResponse
• BidderAuctionInformationResponse
• BidderAuctionItemResponse
• BidderAuctionOfferItemResponse
• BidderAuctionOfferResponse
• BidderAuctionResponse
• BidderAuctionsInformationResponse
• BidderAuctionsResponse
• BidderGroupNew
• BidderGroupResponse
• BidderGroupsResponse
• BidderNew
• BidderNewResponse
• BidderResponse
• BidderUpdate
• BiddersResponse
• BiddingPermissionOfBidder
• CategoriesResponse
• CategoryNew
• CategoryResponse
• CategoryUpdate
• DepartmentInformationResponse
• DepartmentNew
• DepartmentsResponse
• Error
• JResponseID
• JStatus
• ModelEmpty
• OrderInformationResponse
• OrderItemResponse
• OrderResponse
• OrdersInformationResponse
• OrdersResponse
• ProcurementRequestAddressResponse
• ProcurementRequestInformationResponse
• ProcurementRequestItemResponse
• ProcurementRequestNew
• ProcurementRequestNewResponse
• ProcurementRequestResponse
• ProcurementRequestsInformationResponse
• ProcurementRequestsResponse
• UnitsResponse

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Author

support-api@jetract.com