​
Set Up the CloudKit Connector

The CloudKit Connector allows you to ingest documents from your Apple CloudKit Storage into your project.

​
Prerequisites

To set up the CloudKit Connector, you will need the following details from your Apple CloudKit Setup page:
  • CloudKit Container name
  • CloudKit Database name
  • S2S Key ID (Server-to-Server Key ID)
  • EC Key File (the file containing your Elliptic Curve key)

​
Steps

  1. Select CloudKit Data Source Navigate to the Data Sources section of your project. Click Add data source and select CloudKit from the available library.
  2. Provide Connection Details Fill in the required details to connect to your CloudKit storage:
    • CloudKit Container name: Enter the name of your CloudKit container.
    • CloudKit Database name: Enter the name of your CloudKit database.
    • S2S Key ID: Provide your Server-to-Server Key ID.
    • EC Key Data: Upload the file that contains your Elliptic Curve (EC) Key directly into this field.
    • Path: Enter https://api.apple-cloudkit.com
    • Record type: Enter files
    • Is EC Key File Path: Set this to false (indicating that the content of the EC Key File is being provided, not a file path).
  3. Monitor Ingestion Status Once you provide your connection details, the page will refresh to display the ingestion status. You can view the current ingestion status by clicking on the data source again.

​
Next Steps

After your data has been successfully ingested, the CloudKit data source is ready to be used with an Agent.