Latest 5.0.0
License MIT
Platforms ios 9.0
Dependencies GIGLibrary, CryptoSwift

Orchextra SDK for iOS

Build Status
Carthage Compatible

A library that gives you access to Orchextra platform from your iOS app.

Getting started

Start by creating a project in Orchextra Dashboard, if you haven’t done it yet. You’ll need to get your project APIKEY and APISECRET to configure and integrate OCM SDK, you can look them up in Orchextra dashboard by going to "Settings" -> "SDK Configuration".


  • iOS 9.0+

Swift & Xcode version support

ORX Version Swift Version Xcode Version
v3.x 3.x, 4.0, 4.1 9.x
v4.x 4.2 10.x
v5.x 5.0 > 10.2.x



To use Orchextra Core, head on over to the releases page, and download the latest build "". Drag and drop Orchextra.framework.


Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

If you want you can add Orchextra.framework using Carthage, you have to add in your Cartfile file:

github "Orchextra/orchextra-ios-sdk" ~> 3.0

Run carthage update to build the framework and drag the built Orchextra.framework into your Xcode project.

Cocoapods (beta)

Cocoapods is a dependency manager for Swift and Objective-C Cocoa projects. It has over 51 thousand libraries and is used in over 3 million apps. CocoaPods can help you scale your projects elegantly.

Simply add to your Podfilethe following line:

pod 'Orchextra', '~> 3.0'

Set up

Geolocation – Configure Info.plist

You have to provide (it is required) a description of "why the app wants to use location services" in the info.plist
by using the following keys and providing an string with the reason.

  • NSLocationAlwaysUsageDescription
  • NSLocationWhenInUseUsageDescription


Orchextra SDK is composed by the sections of functionality.

Start / Stop

  • Start
  • Stop

Orchextra Core

  • Authentication
  • Bind/Unbind user
  • Bind device
    • Anonimize (GDPR)
  • Business units
  • Tags
  • Custom fields
  • SendORXRequest


  • Scanner
    • Custom
    • ORXScanner
  • Proximity
  • Eddystone


  • Custom Schemes
  • Triggers
  • Push Notifications
    • Register / unregister
    • Handle notifications
      • Local
      • Remote

Latest podspec

    "name": "Orchextra",
    "version": "5.0.0",
    "summary": "A library that gives you access to Orchextra platform from your iOS app.",
    "swift_version": "5.0",
    "description": "Orchextra SDK is composed by the sections of functionality.nn#u00a0Start / Stopnn* Startn* Stopn* Orchextra Corenn#u00a0Authenticationnn* Bind/Unbind usern* Bind devicen* tAnonimize (GDPR)n* Business unitsn* Tagsn* Custom fieldsn* SendORXRequestnn#u00a0Triggeringnn* Scannern* tCustomn* tORXScannern* Proximityn* Eddystonenn#u00a0Actionsnn* Custom Schemesn* Triggersn* Push Notificationsn* Register / unregistern* Handle notificationsn* Localn* Remote",
    "homepage": "",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    "authors": {
        "jcarlosestela": "[email protected]"
    "source": {
        "git": "",
        "tag": "v5.0.0"
    "platforms": {
        "ios": "9.0"
    "source_files": "Orchextra/**/*.swift",
    "resources": "Orchextra/**/*.{xcassets,storyboard}",
    "dependencies": {
        "GIGLibrary": [
            "~> 3.1"
        "CryptoSwift": [
            "~> 0.9"

Pin It on Pinterest

Share This