README

API for integrating with event content aggregated and categorized from many sources and organizers. Use this documentation to build applications on top of Etkinlik.io event data.

For more information, please visit https://etkinlik.io/api-bilgi.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/etkinlik/php-sdk.git"
    }
  ],
  "require": {
    "etkinlik/etkinlik-io-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: apiKey
$config = EtkinlikIo\Api\Configuration::getDefaultConfiguration()->setApiKey('X-Etkinlik-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = EtkinlikIo\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Etkinlik-Token', 'Bearer');


$apiInstance = new EtkinlikIo\Api\Api\CategoriesApi(
    // 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
);

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

API Endpoints

All URIs are relative to https://etkinlik.io/api/v2

Class	Method	HTTP request	Description
CategoriesApi	listCategories	GET /categories	List categories
CitiesApi	listCities	GET /cities	List cities
DistrictsApi	listCityDistricts	GET /cities/{id}/districts	List districts by city
EventsApi	getEvent	GET /events/{id}	Event detail
EventsApi	listEvents	GET /events	List events
EventsApi	recordEventImpression	POST /events/{id}/impressions	Record event impression
FormatsApi	listFormats	GET /formats	List formats
NeighborhoodsApi	listDistrictNeighborhoods	GET /districts/{id}/neighborhoods	List neighborhoods by district
VenuesApi	getVenue	GET /venues/{id}	Venue detail
VenuesApi	listVenues	GET /venues	List venues

Models

Authorization

Authentication schemes defined for the API:

apiKey

Type: API key
API key parameter name: X-Etkinlik-Token
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

bilgi@etkinlik.io

About this package

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

API version: 2.0.5
- Generator version: 7.22.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

etkinlik / etkinlik-io-api

Maintainers

Package info

Statistics

Security