The public API lets another system read and write this business's data with a key made under Admin, API keys. The documentation is served by the same server as the console.
Before you start #
Make an API key under Admin, API keys. Treat the key like a password.
Steps #
- Choose Developers in the sidebar.
- Read the server address.
- Choose Open API documentation. It opens in your browser.
- Choose Guide to read the quick-start article inside the app.
Technical details
The documentation is at /developers on the server. It describes the same routes the console and this app use. Every call carries an Authorization header with a bearer key. An error carries a code and a request_id; quote the request id when you contact support.