The APIs Aera offers, what each is for, and what they have in common.
We're moving our API docs heredocs.aera.id is replacing api-docs.aerahost.com. Until an API has moved, api-docs.aerahost.com is its master. Pages here about those APIs start with a banner that links to the right section there. If the two differ, api-docs is right.
Aera's REST APIs share the same way of getting access, authenticating, handling errors and versioning. This Introduction describes it once.
Terminal API and Cloud integration API, for ECRs and terminals in physical stores.
Online Payments API for webshops and apps: payment sessions, captures, refunds and saved cards.
Identity Services API: create and manage the identities behind ID lookup and loyalty.
Embedded payment API (White Label Wallet): payments inside your own app.
Reporting API: get your reports into your own systems, with a webhook when a new one is ready.
Access PSP and Access API: the access tokens the other APIs need.
Where each API is documented
| Area | API | Master today |
|---|---|---|
| In-store payments | Terminal API, Cloud integration API | docs.aera.id |
| Online payments | Online Payments API | docs.aera.id |
| Reporting | Reporting API | docs.aera.id |
| Access tokens | Access PSP, Access API | api-docs: 4, 3 |
| Identity and signing | Identity Services API | api-docs: 9 |
| Embedded payments | Embedded payment API (White Label Wallet) | aera.readme.io |
The shared rules on these Introduction pages (access, authentication, environments, security, errors and versioning) come from api-docs: 2, 19 and 20. For those rules, api-docs is the master too.
Looking for an Aera API that isn't listed here? Ask your Aera contact.
How they compare
| API | Style | Host (production) | Access token from |
|---|---|---|---|
| Online payments | REST, JSON | psp.aerahost.com | Access PSP |
| Reporting API | REST, JSON and CSV, with webhooks | api.aerahost.com | Access API |
| Terminal messages (Nexo) | Nexo Retailer 3.1 messages | AIC in the store (Local integration) or Aera's cloud (Cloud integration) | Not used for local integration |
Test hosts are on Environments. For the Identity Services API and the Embedded payment API, see their own pages.
All REST APIs use HTTPS only, and send and receive JSON in UTF-8. The terminal messages follow the Nexo standard, not OpenAPI. That's why their pages have field tables and examples, but no "Try it" panel.
Start here
- Get access to the API you need.
- Get an access token. See Authentication.
- Build and test against the test hosts. See Environments.
- Check what Aera sends with Signatures and security.
- Handle Errors and response codes.
- Make your integration ready for new fields. See Versioning and changes.