This guide shows the fastest path from credentials to a submitted order.
Prerequisites
You need:
- An ArchiveOrder API key.
- The
orders:write scope to create orders.
- The
orders:read scope to read the created order.
- A client that can make HTTPS requests.
1. Choose an environment
Use the development environment while integrating:
Use production only after GenealogyDirect enables your production API client:
2. Create an order
The response contains the public order ID and current status:
3. Read the order
4. Poll for offers
When offers are available, select one and continue with payment:
5. Register webhooks
Polling works for early integration. Production integrations should register a webhook endpoint:
Store the returned signingSecret. You need it to verify webhook signatures.
Use a stable Idempotency-Key when retrying the same mutating request after a timeout or network failure.
