Connect your own API to your app – Step-by-Step Guide | Vibe96
Vibe Studio

Connect your own API to your app

Published Last updated 2 min readBy Vibe96 team

Short answerYou can connect an outside API that is not a ready integration, such as a company ERP or CRM, a local payment gateway, or a government or partner API. Give its address, documentation and key; keys are stored encrypted.

Your business already runs on other systems. Your new app should talk to them, not live beside them.

What you can connect

A service that is not on Vibe Studio's list of ready connections:

  • a company ERP or CRM,
  • a local payment gateway,
  • a government or partner API,
  • your own back-end.

For well-known services such as Stripe, WhatsApp or Google, use the ready connections instead. See Connect outside services and keep your keys safe.

What you need

  • The address of the API.
  • Its documentation: a link or a file that says what you can ask for and what comes back.
  • A key, if the API needs one.
  • A sentence about what you want your app to do with it.

Steps

  1. Open your project and tell Nova: "I want to connect our ERP's API to show stock in the shop."
  2. Choose to connect an outside API and enter its address, its documentation and its key.
  3. Nova reads the documentation and writes tasks, each with a price.
  4. Tick the tasks and press Develop.
  5. Test on your test link with real requests.

Keys are stored encrypted as project secrets, never in the code, and are never shown to Nova.

๐Ÿ’ก Ask the API's owner for a test account first. Building against live data is how test orders end up in the real ERP.

Say exactly what should happen

Good instructions name the direction and the moment:

  • "When an order is paid, send it to the ERP."
  • "Every night, bring the price list from the ERP into the shop."
  • "On the booking page, check the doctor's free times with the clinic system before showing them."

Plan for the bad day

An outside system can be slow or down. Tell Nova what your app should do then:

  • "If the ERP does not answer, save the order and try again later."
  • "Show the last known stock with a note."
  • "Email me when a send has failed three times."

Change or remove a connection

  • Reconnect with a new key at any time. Leave the key field empty to keep the saved one.
  • When you remove a connection, its keys are deleted from your project settings. The code that uses it stays until you ask Nova to change it.

Safety

  • Give the API key only the rights your app needs.
  • Use one key for the test link and another for your live site.
  • Never paste a key into the chat.

When it gets complicated

Old systems, special sign-in methods or unclear documentation can take time. A human expert can do the connection with you. See Hire an expert.

๐Ÿ’ก Good documentation is half the work. If the API has none, ask its owner for three example requests with their answers and attach them.

Questions

Does my API key end up in the code?

No. Keys are stored encrypted as project secrets, never in the code.

What happens when I remove a connection?

Its keys are deleted from your project settings. The code stays until you ask Nova to change it.

Can I connect a government or partner API?

Yes, if you have its address, documentation and a key.

Was this guide helpful?