Onboard a Customer via AWS
Register a customer organization and set up AWS cloud integration using the Archera Partner API
Use the Archera Partner API to programmatically onboard customers and set up AWS cloud integration.
Prerequisites:
Partner API key and partner organization ID
Contact your Archera representative if you don't have these credentials
Base URL: https://api.archera.ai/v2
Authentication: Include x-api-key: YOUR_PARTNER_API_KEY header in all requests.
The examples use shell variables. Set them once, with your real values, before you run any command:
export PARTNER_API_KEY="your-partner-api-key"
export PARTNER_ORG_ID="your-partner-organization-id"Step 1: Register the customer organization
curl -X POST \
-H "x-api-key: $PARTNER_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"name": "Acme Corp",
"users": [{"email": "admin@acmecorp.com", "role": "admin"}]
}' \
https://api.archera.ai/v2/partners/$PARTNER_ORG_ID/orgsname must be unique across Archera. A name that is already in use returns 409. Each entry in users is invited to the new organization with the given role.
Save from response: id. This is the customer organization ID. The next steps use it as CHILD_ORG_ID:
Step 2: Get AWS CloudFormation launch URL
Add ?read_only=true to onboard without purchase permissions. Archera can then read cost data and commitments but cannot buy or exchange them.
Send the returned url to your customer to deploy the CloudFormation stack in their AWS management account.
Step 3: Verify AWS integration
After the customer deploys the stack, send the ID of the AWS account where the stack was deployed:
account_id is required. If you used read_only=true in Step 2, also send "read_only": true here.
Check response: a list of {feature, status} entries. Every feature should report available. A 400 response carries a code and a message that you can show to the customer.
What You Can Do
The Archera Partner API enables you to:
Register customer organizations under your partner account
Set up AWS cloud integration using CloudFormation templates
Verify integration status and data collection
Access commitment recommendations for your customers
Execute purchases on behalf of customers
This allows you to build Archera's cost optimization capabilities directly into your platform.
Last updated
Was this helpful?

