Get started
Both integrations start the same way: a test API key, the test environment and a fictional client. Then you choose a path.
1. Get a test API key
Generate test and production keys at app.debitura.com/ReferralPartnerApiKey, or ask your partnership contact. Keys are environment-specific. Send the key in the XApiKey header, from your server only.
The Starter Integration needs nothing more. The Full Integration also mints a short-lived bearer token per client. See API keys and authentication.
2. Build against the test environment
Every example in these docs uses the test hosts:
| Service | Test |
|---|---|
| Referral Partner API | https://testreferral-api.debitura.com |
| Customer API (Full Integration) | https://testcustomer-api.debitura.com |
Test data never reaches a collection partner, and emails to domains that are not whitelisted are suppressed. See Environments and test data for every host, isTest and resetting test clients.
3. Choose your path
| If you… | Start with |
|---|---|
| want users to send an invoice with one click and let Debitura handle setup | Starter quickstart |
| also want to show the fee first, or show case status inside your app | Starter, then add POST /cases/preview or Customer API reads for the same client |
| want to design your own sign-up and agreement screens | How the Full Integration works, then the Full quickstart |
You can change your mind later. Starter and Full share the same clients and cases, so a Starter client can use Full endpoints at any time without onboarding again. The Overview compares both paths side by side.
Before production
You'll need a production key and your go-live checklist completed. Branding (logo and colour) and the return destination for hosted pages are set on your partner account; see Branding and hosted pages.
Business context: see Getting started with Debitura for the partnership steps.