{"id":19951011,"url":"https://github.com/sygic-travel/apple-sdk","last_synced_at":"2025-05-03T18:33:32.737Z","repository":{"id":62457071,"uuid":"82306097","full_name":"sygic-travel/apple-sdk","owner":"sygic-travel","description":"Sygic Travel SDK framework for all Darwin platforms","archived":false,"fork":false,"pushed_at":"2024-05-05T23:52:41.000Z","size":791,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-05-06T22:25:45.826Z","etag":null,"topics":["darwin","framework","ios","macos","objective-c","poi","sdk","swift","swift-playgrounds","tours","travel","travelling","tvos"],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sygic-travel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-17T14:41:56.000Z","updated_at":"2021-06-30T18:53:23.000Z","dependencies_parsed_at":"2024-05-05T22:25:47.718Z","dependency_job_id":null,"html_url":"https://github.com/sygic-travel/apple-sdk","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sygic-travel%2Fapple-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sygic-travel%2Fapple-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sygic-travel%2Fapple-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sygic-travel%2Fapple-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sygic-travel","download_url":"https://codeload.github.com/sygic-travel/apple-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224370096,"owners_count":17299969,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["darwin","framework","ios","macos","objective-c","poi","sdk","swift","swift-playgrounds","tours","travel","travelling","tvos"],"created_at":"2024-11-13T01:06:30.372Z","updated_at":"2024-11-13T01:06:30.905Z","avatar_url":"https://github.com/sygic-travel.png","language":"Objective-C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sygic Travel Apple SDK\n\n\n**Sygic Travel Apple SDK** (stylised for Apple platforms as _TravelKit_) is a framework suitable for embedding a rich set of _Sygic Travel_ data within your application. It gives you access to millions of Places covering the entire world.\n\nWe build it as a generic platform project available on all Apple platforms.\n\nFor further details see [Full SDK documentation](http://docs.sygictravelapi.com/apple-sdk/latest/).\n\n## Getting the SDK\n\n### Installing via CocoaPods\n\nSimply add a `TravelKit` pod to your `Podfile`. Then run `pod update` to fetch the SDK automatically.\n\n### Getting the framework from GitHub\n\nYou can grab a released compiled SDK package or its source code on [GitHub](https://github.com/sygic-travel/apple-sdk). Check out the repository or grab it from the _Releases_ section.\n\n## Development Requirements\n\nAll development requirements are actually recommendations as it reflects the environment we use to develop and distribute the code.\n\n- Xcode 8.0+ (recommended)\n- macOS 10.12+ SDK (recommended)\n- iOS 10.0+ SDK (recommended)\n- tvOS 10.0+ SDK (recommended)\n- _Objective-C_ or _Swift_ project\n- _API key_ for your business or project\n\n## Production Deployment\n\nDeployment requirements determine the minimal environments compatible with the SDK when you distribute it with your project.\n\n- OS X/macOS 10.10+ target (_macOS framework_)\n- iOS 8.2+ target (_iOS framework_)\n- tvOS 9.0+ target (_tvOS framework_)\n\n## Installation\n\n- get the framework package\n- unpack and add to your project\n- link it as a dynamic framework (embedded binary) in your project settings\n\n## Configuration\n\nActually the only step needed is obtaining an _API key_ you use to set up the framework before you start using it. [Contact us](https://travel.sygic.com/b2b) to get one.\n\n## Quick Usage Introduction\n\nThis quick example shows how to use the SDK to fetch a representative set of data.\n\nLet's define a set of Places we want:\n\n- placed in _London_\n- marked as _Points of interest_\n- included in the _Sightseeing_ category\n- only the _Top 10_ of them\n\n```objc\n// Hold an instance\nTravelKit *kit = [TravelKit sharedKit];\n\t\n// Set your API key\nkit.APIKey = @\"\u003cYOUR_API_KEY_GOES_HERE\u003e\";\n\t\n// Create query to get Top 10 Sightseeing Places in London\nTKPlacesQuery *query = [TKPlacesQuery new];\nquery.parentIDs = @[ @\"city:1\" ];\nquery.levels = TKPlaceLevelPOI;\nquery.categories = TKPlaceCategorySightseeing;\nquery.limit = 10;\n\t\n// Perform query and print a message containing the first item\n[kit placesForQuery:query completion:^(NSArray\u003c TKPlace *\u003e *places, NSError *error){\n\tif (places.firstObject) NSLog(@\"Let's visit %@!\", places.firstObject.name);\n\telse NSLog(@\"Something went wrong :/\");\n}];\n```\n\n```swift\n// Set your API key\nTravelKit.shared.apiKey = \"\u003cYOUR_API_KEY_GOES_HERE\u003e\"\n\t\n// Create query to get Top 10 Sightseeing Places in London\nlet query = TKPlacesQuery()\nquery.parentIDs = [\"city:1\"]\nquery.levels = .POI\nquery.categories = [.sightseeing]\nquery.limit = 10\n\t\n// Perform query and print a message containing the first item\nTravelKit.shared.places.places(for: query) { (places, error) in\n\tif let place = places?.first { print(\"Let's visit \\(place.name)!\") }\n\telse { print(\"Something went wrong :/\") }\n}\n```\n\nThe *API key* must be provided, otherwise using any methods listed below will result in an error being returned by the completion block.\n\n*TravelKit* is very easily testable using _Swift Playgrounds_ – a sample playground is provided together with the workspace attached.\n\n## Basic Classes\n\nClass               | Description\n:-------------------|:---------------------\n**`TravelKit`**       | Singleton instance for fetching data\n**`TKPlace`**         | Basic `Place` entity\n**`TKPlacesQuery`**   | Entity used when querying for `Places`\n**`TKTrip`**          | Primary `Trip` entity with detailed properties \n**`TKTour`**          | Basic `Tour` entity\n**`TKToursViatorQuery`**    | Entity used when querying for `Tours` from _Viator_\n**`TKToursGYGQuery`**    | Entity used when querying for `Tours` from _GetYourGuide_\n**`TKMedium`**        | Basic `Medium` entity\n**`TKReference`**     | External `Reference` link\n\n## Documentation\n\nAvailable on [Docs portal](http://docs.sygictravelapi.com/apple-sdk/latest/).\n\n## License\n\nThis project is licensed under the terms of the MIT license. See the **LICENSE** file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsygic-travel%2Fapple-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsygic-travel%2Fapple-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsygic-travel%2Fapple-sdk/lists"}