etkinlik_io_api 2.0.5
etkinlik_io_api: ^2.0.5 copied to clipboard
Official Dart and Flutter client for the Etkinlik.io V2 REST API. Access events
etkinlik_io_api #
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.
This Dart 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.DartDioClientCodegen For more information, please visit https://etkinlik.io/api-bilgi
Requirements #
- Dart 2.15.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
etkinlik_io_api: 2.0.5
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
etkinlik_io_api:
git:
url: https://github.com/etkinlik/dart-sdk.git
#ref: master
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
etkinlik_io_api:
path: /path/to/etkinlik_io_api
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:etkinlik_io_api/etkinlik_io_api.dart';
final api = EtkinlikIoApi().getCategoriesApi();
try {
final response = await api.listCategories();
print(response);
} on DioException catch (e) {
print("Exception when calling CategoriesApi->listCategories: $e\n");
}
Documentation for 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 |
Documentation For Models #
- ApiAuthorizationError
- ApiDeletedError
- ApiDuplicateRecordError
- ApiGeneralError
- ApiNotFoundError
- Category
- City
- District
- Event
- EventImpressionCreated
- EventImpressionRequest
- EventVenueData
- Format
- Neighborhood
- PaginatedEvents
- PaginatedVenues
- PaginationMeta
- Tag
- Venue
- VenueManual
Documentation For Authorization #
Authentication schemes defined for the API:
apiKey #
- Type: API key
- API key parameter name: X-Etkinlik-Token
- Location: HTTP header