Developers › Getting started

Get API access

Who can create keys, and how to keep them safe.

Every Prospera company has its own address and its own API. Your administrator creates access for each integration, so you can see and stop any connection at any time.

  1. Ask your administrator

    API access is created by an administrator in your company. If you are a partner building for a client, ask the client to create a dedicated user for your integration.

  2. Use one user per integration

    Give each integration its own user with only the roles it needs. You will always know which connection did what, and you can switch one off without touching the others.

  3. Keep keys secret

    Store keys in your server’s secret store, never in code, emails or chat. Anyone holding a key can act as that user.

  4. Rotate when people change

    Create new keys when someone who knew them leaves, or if a key may have been seen. The old key stops working as soon as new ones are created.

Good to know

  • Ask us for a test company. Build and test there, then switch the address and keys when you go live.
Still need help?WhatsApp and email answered 24/7. Live support Sunday to Thursday, 8 am to 6 pm.
Book a training session