The Swift SDK

The Swift SDK, CareersOrbit, shows live jobs from the delivery API, takes applications with a CV and runs the candidate portal in iOS, iPadOS, macOS, tvOS and watchOS apps, and in server-side Swift. It does what the client in the JavaScript Careers SDK does, with the same errors. It is open source under the MIT licence.

• async/await on URLSession, with no dependencies
• Safe under Swift 6 strict concurrency: the clients and every model are Sendable
• Codable models for every answer, with a JSONValue for a job's JobPosting data
• Retries, timeouts and typed errors

It needs Swift 5.9 or later, and iOS 15, macOS 12, tvOS 15 or watchOS 8 or later.

Install

In Xcode, choose File › Add Package Dependencies… and enter https://github.com/bifrost-orbit/careers-sdk-swift, then add the CareersOrbit product.

In Package.swift:

1dependencies: [2    .package(url: "https://github.com/bifrost-orbit/careers-sdk-swift", from: "0.1.0"),3],4targets: [5    .target(name: "App", dependencies: [.product(name: "CareersOrbit", package: "careers-sdk-swift")]),6]

Set up

Create a public key under API keys. It can only read live jobs and send applications, so it is safe to ship in an app.

1import CareersOrbit23let careers = try CareersOrbitClient(publicKey: "careers_pk_...", locale: "de")45let list = try await careers.jobs(.init(remote: "hybrid", query: "guide"))6for job in list.items {7    print(job.title, job.locations.first?.city ?? "")8}

Methods

Applications

1let job = try await careers.job("mountain-guide-lofoten")23let application = CareersApplication(4    firstName: "Kari",5    lastName: "Nordmann",6    email: "kari@northwilds.com",7    phone: "+47 912 34 567",8    answers: ["q-years": 6, "q-areas": ["lofoten", "lyngen"], "q-first-aid": .yesNo(true)],9    privacyVersion: job.privacy.version,10    privacyAccepted: true,11    source: "northwilds-app"12)13let files = CareersApplicationFiles(cv: CareersFile(name: "kari-nordmann.pdf", data: cvData))14let result = try await careers.apply(to: job.slug, application, files: files)

Send the standard fields job.form asks for (job.form.asks("phone")) and an answer for each question, keyed by its id. Choice answers are option ids. privacyAccepted must be true; the client refuses the application before sending it otherwise. Files are PDF or Word documents up to 10 MB.

Candidate portal

CareersPortalClient lets candidates sign in with an emailed code and follow their applications in your app. Keep the session token somewhere safe, such as the Keychain, by implementing CareersSessionStore; CareersMemorySession keeps it in memory.

1let portal = try CareersPortalClient(publicKey: "careers_pk_...", locale: "de", session: KeychainSession())23try await portal.requestCode(email: "solveig@northwilds.com")4try await portal.signIn(email: "solveig@northwilds.com", code: "123456")5if let me = try await portal.me(), let offer = me.offers.first(where: { $0.status == "open" }) {6    _ = try await portal.openOffers()7    _ = try await portal.acceptOffer(offer.id, acceptance: CareersOfferAcceptance(name: "Solveig Haugen", consent: true, documentHash: offer.documentHash ?? ""))8}

Calls that change something answer with the whole CareersPortal again. A 401 throws .signedOut and clears the session store. Leave out publicKey when baseURL is your own server, which adds the key.

Errors

Everything throws CareersOrbitError, apart from CancellationError when the calling task is cancelled.

Messages are written for candidates, in the language of the request. See Troubleshooting.

Testing your app

Pass a URLSession whose configuration has your own URLProtocol in protocolClasses, and answer requests with JSON shaped like the delivery API. The SDK's own tests do this in Tests/CareersOrbitTests/StubProtocol.swift.