How to Access API Documentation

Mehdi Emami
Mehdi Emami
  • Updated

To access Zip's API documentation, log in to your Zip account and click the question mark icon.

question-mark.png

Then, select API Documentation from the drop-down menu.

api-docs.png

After that, Zip automatically handles the authentication into the gated API docs and the API documentation opens in a new tab.

api documentation example.png
  1. The API Reference tab is selected by default.  This features a list of end points on the left-hand side; select an endpoint to learn more about the various methods and parameters used by the API.
  2. The Guides tab contains long-form explanations of basic Zip functionality and use case examples of common API implementations.

Was this article helpful?

/

Comments

0 comments

Please sign in to leave a comment.