Skip to content

API documentation

ZonD Eighty edited this page May 4, 2017 · 18 revisions

Versions:

1.0: 15.12.2013 - Initial release.

1.1: 16.01.2014 - Parameter "added" in UDID lookup to handle annual registrations.

1.11: 24.01.2014 - Added additional parameters to status lookup

1.12: 11.03.2014 - Removed "from_failed" re-registration transaction prefix

1.13: 25.04.2014 - Added "start" and "limit" parameters to "status"

1.15: 08.06.2014 - Added "registered_at" prop to UDID status results. Added "delete_key" parameters to "status"

2.0: 26.04.2016 - Second version.

2.01: 04.05.2016 - Change of API endpoint.

Before your start:

  1. Register on https://partners.regmyudid.cc as a Partner.
  2. Top-up your account balance.
  3. Remember your client ID and define your API password.

Overall:

All API calls handled by https://secure.regmyudid.cc/API/v2.0/

API responses in JSON.

Responses are JSON-encoded objects/arrays, containing the following required fields:

  • error - Text message describing error. It is empty string if there is no errors.
  • auth - Boolean. Authenticated you or not.
  • data - json-encoded object/array of response data for your request.

You need to be authenticated by your client ID and API password to preform any actions with API.

Authentication process

Add the following required fields to your request:

  • api_client_id - your client ID.
  • api_password - your API password.

Example: https://secure.regmyudid.cc/API/v2.0/?api_client_id=0&api_password=test

You must to keep this fields in every request you make.

Retrieving status of UDID or email

Add the following additional fields to your request:

  • mode = "status", without quotes.
  • udid = UDID of customer you need to check.
  • added = Unix timestamp of UDID arrival to system (optional).
  • start = A record to start from (default 0, optional).
  • limit = A limit of UDIDs to be shown (default 10, optional).
  • transaction_id = Your transaction ID.

Example response: {"error":false,"auth":true,"data":[{"error":"Expired registration","udid":"xx","status":"ok","type":"CERT","email":"xxx@icloud.com","transaction_id":"54774234","delete_key":"xxx","queue_no":null,"added":"Wed, 17 Sep 2014 01:02:18 +0000","paid":"Wed, 17 Sep 2014 00:57:18 +0000","registered_at":"Wed, 17 Sep 2014 01:02:18 +0000","certificate":"https:\/\/secure.regmyudid.cc\/download.php?dt=lYDs1lKkq8g9clEbDOkPTms16EMqb4gsAbobukYe1iPC52xkLOxK0xXTve%x%2BZTZL3MBQpfqBFD80QX0nfow%2BbhSDJZ2h7iqsutZ0i9JOZHeg2j4IMhOKhg","mobileprovision":"https:\/\/secure.regmyudid.cc\/download.php?dt=e8cvShmHbiEcNqu%2BY8Fd0%2Bq7ScWMnVfIzSWm0K49%2B8bjT6ADo9xxqnSX%xx%2B6QFtViuvqk5O4k2lB7vovJ7BQb3dmM%2BoKr282UvnFUtxtwW6gowIyWZ","p12":"https:\/\/secure.regmyudid.cc\/download.php?dt=xxx%2FKOMUV8FqQcBFNcTPqjA%3D"}]}

Where some fields are self-explainable and:

  • queue_no = number in queue, if status is "paid".
  • certificate = link to download apple developer certificate (without private key).
  • mobileprovision = link to download mobile provisioning profile.
  • p12 = link to download PFX bundle with apple developer certificate and corresponding private key.

Registering UDID

Add the following additional fields to your request:

  • mode = "register", without quotes.
  • udid = UDID of device.
  • email = EMAIL of customer.
  • type = "REG" or "CERT" for normal or advanced registration.
  • transaction_id = Transaction ID of invoice in your payment system. It must to be unique.
  • callback_uri = an URL where POST notification about UDID status will be sent.

Example response:

{"error":"","auth":true,"data":{"success":true,"message":"UDID scheduled for registering"}}

If callback_uri is defined, our system will send you HTTP POST notifications to defined callback_uri with the following payload: udid - UDID that was scheduled for registration status - status of UDID registration. Can be "new", "paid", "registering", "ok", "payment_failed", "error" transaction_id - your transaction id

Retrieving partner statistics

Add the following additional fields to your request:

  • mode = "statistics", without quotes.

Example response:

{"error":false,"auth":true,"data":{"certs":{"ok":"3","pending":"0","failed":"0","free":"unlimited"},"regs":{"ok":"0","pending":"0","failed":"0","free":"unlimited"}}}

All fields are self-explainable.

Clone this wiki locally
You can’t perform that action at this time.