spaceship exposes both the Apple Developer Center and the iTunes Connect API. This fast and powerful API powers parts of fastlane, and can be leveraged for more advanced fastlane features. Scripting your Developer Center workflow has never been easier!
Get in contact with the creators on Twitter: @FastlaneTools
spaceship is part of fastlane: The easiest way to automate beta deployments and releases for your iOS and Android apps.
Up until now, the fastlane tools used web scraping to interact with Apple's web services. With spaceship it is possible to directly access the underlying APIs using a simple HTTP client only.
Using spaceship, the execution time of sigh was reduced from over 1 minute to less than 5 seconds.
spaceship uses a combination of 3 different API endpoints, used by the Apple Developer Portal and Xcode. As no API offers everything we need, spaceship combines all APIs for you. More details about the APIs.
More details about why spaceship is useful on spaceship.airforce.
No matter how many apps or certificates you have, spaceship can handle your scale.
Enough words, here is some code:
. # Create a new app app = ..create!(bundle_id: "com.krausefx.app", name: "Spaceship App") # Use an existing certificate cert = ..production.all.first # Create a new provisioning profile profile = ..app_store.create!(bundle_id: app.bundle_id, certificate: cert) # Print the name and download the new profile puts "Created Profile " + profile.name profile.download
How fast are tools using
spaceship compared to web scraping?
sudo gem install spaceship
spaceship, just run
spaceship. It will automatically start the
spaceship playground. It makes it super easy to try
This requires you to install
sudo gem install pry.
pry is not installed by default, as most fastlane users won't need the
spaceship playground. You can add the
pry dependency to your
Apple Developer Portal API
Open DeveloperPortal.md for code samples
iTunes Connect API
Open iTunesConnect.md for code samples
2 Step Verification
When your Apple account has 2 factor verification enabled, you'll automatically be asked to verify your identity using your phone. The resulting session will be stored in
~/.spaceship/[email]/cookie. The session should be valid for about one month, however there is no way to test this without actually waiting for over a month.
Since your CI system probably doesn't allow you to input values (like the verification code), you can use
spaceauth -u [email protected]
This will authenticate you and provide a string that can be transferred to your CI system:
export FASTLANE_SESSION='---\n- !ruby/object:HTTP::Cookie\n name: DES5c148586dfd451e55afbaaa5f62418f91\n value: HSARMTKNSRVTWFla1+yO4gVPowH17VaaaxPFnUdMUegQZxqy1Ie1c2v6bM1vSOzIbuOmrl/FNenlScsd/NbF7/Lw4cpnL15jsyg0TOJwP32tC/NguPiyOaaaU+jrj4tf4uKdIywVaaaFSRVT\n domain: idmsa.apple.com\n for_domain: true\n path: "/"\n secure: true\n httponly: true\n expires: 2016-04-27 23:55:56.000000000 Z\n max_age: \n created_at: 2016-03-28 16:55:57.032086000 -07:00\n accessed_at: 2016-03-28 19:11:17.828141000 -07:00\n'
Copy everything from
---\n to your CI server and provide it as environment variable named
spaceship in use
All fastlane tools that communicate with Apple's web services in some way, use spaceship to do so.
Up until now all fastlane tools used web scraping to interact with Apple's web services.
spaceship uses a simple HTTP client only, resulting in much less overhead and extremely improved speed.
spaceship (HTTP client) over web scraping:
- Blazing fast :rocket: 90% faster than previous methods
- No more overhead by loading images, HTML, JS and CSS files on each page load
- Great test coverage by stubbing server responses
- Resistant against design changes of the Apple Developer Portal
- Automatic re-trying of requests in case a timeout occurs
Overview of the used API endpoints
https://idmsa.apple.com: Used to authenticate to get a valid session
- Get a list of all available provisioning profiles
- Register new devices
- List all devices, certificates, apps and app groups
- Create new certificates, provisioning profiles and apps
- Disable/enable services on apps and assign them to app groups
- Delete certificates and apps
- Repair provisioning profiles
- Download provisioning profiles
- Team selection
- Managing apps
- Managing beta testers
- Submitting updates to review
- Managing app metadata
- Upload icons, screenshots, trailers ...
spaceship uses all those API points to offer this seamless experience.
spaceship does a lot of magic to get everything working so neatly:
- Sensible Defaults: You only have to provide the mandatory information (e.g. new provisioning profiles contain all devices by default)
- Local Validation: When pushing changes back to the Apple Dev Portal
spaceshipwill make sure only valid data is sent to Apple (e.g. automatic repairing of provisioning profiles)
- Various request/response types: When working with the different API endpoints,
spaceshiphas to deal with
plistand sometimes even
HTMLresponses and requests.
- Automatic Pagination: Even if you have thousands of apps, profiles or certificates,
spaceshipcan handle your scale. It was heavily tested by first using
spaceshipto create hundreds of profiles and then accessing them using
- Session, Cookie and CSRF token: All the security aspects are handled by
- Profile Magic: Create and upload code signing requests, all managed by
- Multiple Spaceship: You can launch multiple
spaceshipswith different Apple accounts to do things like syncing the registered devices.
Code of Conduct
Help us keep
fastlane open and inclusive. Please read and follow our Code of Conduct.
This project is licensed under the terms of the MIT license. See the LICENSE file.
This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.