API and webhooks
Everything the portal does, your build pipeline can do. The API is the same code path as the interface, so nothing is available in one and missing from the other.
Not yet exposed. The key management, the scopes and the webhook delivery machinery are built and tested, and the endpoints are the next piece of work. This page describes what is coming so you can tell whether it will fit your pipeline, and it will be replaced with the reference when the routes land.
Authentication
A bearer key created in the portal, of the form rxk_XXXXXXXXXXXXXXXX.SECRET. Only the hash
is stored, so the secret is shown once and cannot be recovered — create
a new key rather than asking us to find an old one. Keys carry scopes and
can be given an expiry.
What it will cover
- Create a release and upload a build.
- Run the pre-submission checks and read the results, so your pipeline can fail before a human waits.
- Submit to a set of stores, idempotently: the same key submits once however many times your pipeline retries.
- Read the state of every submission, rejection and store review.
- Set or halt a staged rollout.
- Read installs, ratings and the earnings ledger.
Webhooks
You give us an https endpoint and we post signed JSON when something happens: a submission is accepted, a store rejects something, a rollout is halted, a settlement arrives. Each delivery carries an HMAC over the timestamp and the body, so a replayed request is detectable. A webhook that keeps failing is switched off and you are told, rather than retried for ever.
What the API will never do
Export your signing key material. That path needs a human with a second factor on a session that is not being impersonated, because an API key sitting in a build server is not a good enough guard for the one thing that cannot be replaced.