Quickstart
Integrate an Admoji-powered checkout in four steps
This walkthrough gets a website integrated with Admoji end to end: authenticate, add a customer, take a signup payment, and (optionally) charge an upsell.
1. Get your API key
Sign in to the Admoji CRM and open Settings → Account settings → API Keys. Copy the key (it looks like secret_492796e421a34666a5695d53cd311111) and keep it server-side — treat it like a password.
API keys are workspace-scoped. Use a test key while integrating and swap to your live key at go-live.
2. Verify authentication
Send a GET to the test-auth endpoint. A Status of 0 means the key is valid.
See Authentication for header format, key rotation, and error handling.
3. Add a customer
Create a customer record before charging. All POST requests must include an Idempotency-Key (any UUID) — see Idempotency.
Full request/response schema: POST /api/v2/open/customer.
4. Add a signup transaction
Once the customer exists, place the initial order via the signup-transaction endpoint. The response returns the CRM order ID plus processor authorization.
Full schema: POST /api/v2/open/signup-transaction.
5. (Optional) Add upsell transactions
Charge additional products against the same customer without re-collecting a payment method.
Full schema: POST /api/v2/open/upsell-transaction.
