Question

How do you define "API Documentation"

  • 14 December 2020
  • 5 replies
  • 795 views

Userlevel 2

We are trying to publish our integration but one field is “API Documentation URL”. When we try to understand what you mean by this, we click on the guidelines here:

https://platform.zapier.com/partners/document-support

 

And this says “Coming Soon”… 

 

We are being asked to provide a document but it’s not documented what Zapier wants.

 

So is this meant to be a technical document or more user friendly guide on how to use our integration to make a zap. For example is it something like what LeadPages has done here: https://support.leadpages.com/hc/en-us/articles/360002382371-Integrate-Zapier-With-Leadpages ???

 

Some examples would be appreciated as I can’t tell what you really want. Also, where is this URL listed for each integration? I can’t find it for the example above - had to find it with a Google search… 

 

Thanks,

Peter


This post has been closed for comments. Please create a new post if you need help or have a question about this topic.

5 replies

Userlevel 7
Badge +14

Examples

  1. Mailchimp API Reference: https://mailchimp.com/developer/api/
  2. Pipedrive API Reference: https://developers.pipedrive.com/docs/api/v1/
Userlevel 2

Thanks Troy… but… this has me more confused.

 

The above examples are for overall API’s. 

 

Our software doesn’t have a published API but we want to pubish our integration with Zapier. Still not sure what they are asking for.

Userlevel 7
Badge +9

 

The purpose of that doc link is for the Zapier support team, in the future, as they research and troubleshooting bugs, triaging issues, and helping our mutual customers.  So I’d add whatever you feel is the most helpful toward that end.  It won’t be a link that makes it into the customer-facing experience.  

 

Thanks for pointing out the gap in the docs.

 

 

Userlevel 2

 

The purpose of that doc link is for the Zapier support team, in the future, as they research and troubleshooting bugs, triaging issues, and helping our mutual customers.  So I’d add whatever you feel is the most helpful toward that end.  It won’t be a link that makes it into the customer-facing experience.  

 

Thanks for pointing out the gap in the docs.

 

 

Hi Zane - ok so if we don’t have a published API, what do we submit? Link to a page that says we don’t have an API and to use Zapier? That’s the plan I guess.

Userlevel 7
Badge +10

@pdog 

An API is how Zapier connects to your app. So if you don’t have an API, this is all moot.

If you mean you have an API, but it’s not publically documented, I think you'll need it to be. I believe Zapier asks for this URL so they can look at the docs when they are doing QA on your integration.