I recently developed a new REST API for a company. I've created a Postman collection including some sample requests for real-world scenarios. I need to share this collection with other members of the organization.
I found a "Publish Docs" menu option for Postman collections which is pretty cool. It publishes web pages of the documentation and then displays the url for where the documentation can be accessed:
https://documenter.getpostman.com/view/1401123/RWML234Hd
One issue is that the documentation is publicly available to anyone who has the url. Meaning that anyone on the internet could potentially access the documentation. This is a corporate API and should only be accessible within the organization.
Another issue is that it appears that the published url changes every time I "Publish Docs." That's a problem b/c I need to provide a static url for Postman examples on the corporate intranet page listing API resources. My manager won't spend any money on this. I like the documentation feature but:
The documentation should have a static url
The documentation should not be accessible by anyone on the internet who gets a hold of the url
Would I need to pay license costs to satisfy the 2 requirements listed above? What would be my best free option? The default free option for me would be to save off the collection json to a shared drive on the network.
I've been asking this very question for a while now. Finally decided to implement a simple tool that generates an HTML document similar to what postman does.
hope this helps -
https://github.com/karthiks3000/postman-doc-gen
Related
is it possible to find hidden paths and files of a Website and/or API when it hasnt got any docs about the Paths and endpoints?
You can always contact the author of the API and ask if there are any public facing endpoints that you can access that lack documentation.
The API Documentation states that the Content API can be used to:
Edit and publish blog posts and web pages, improve SEO, and drive traffic to stores.
I'm working on migrating a site from a different platform onto BigCommerce. I was able to migrate all of the blog posts fairly easily using the API, but the documentation for the web pages resource is completely missing.
Any help here would be greatly appreciated. Thank you.
This API endpoint doesn't currently exist. It is, however, in progress. I don't have an available ETA to provide around this. This wording on the docs is misleading.
We are hoping to upload a chrome extension and publish it as unlisted (as the visibility option) via the Chrome Webstore Api.
So far we have been able to upload but not publish using this documentation -- we can't publish because extensions have a whole bunch of required parameters (like a screenshot or small-tile image) which we can't figure out how to attach. We are really hoping that one of these parameters will be visibility, and we can set it to "unlisted".
If any kind soul has any knowledge of the Chrome Webstore API, or how to set these parameters, our whole development team would be very appreciative.
The documentation on this is very sparse: https://developer.chrome.com/webstore/webstore_api/items/update
Quoting Using the Chrome Web Store Publish API:
Note: Currently, there is no API for setting an item’s metadata, such as description. This has to be done manually in the Chrome Web Store Developer Dashboard. More detail about the Web Store API can be found here.
So, to the question whether you can supply all the metadata programmatically - the answer is "no". And the Publish method does not seem to support "unlisted".
(I am reposting this question here because I tried on the google news group and got no responses.)
I need to build a shop for my client, and the client already has a domain and a web site. I need to integrate e-commerce functionality in to the site. This is going to be done by sending AJAX requests to the API.
my question is whether I need to get a partner account for this? I am not yet going to write an app that people would install, I am just building a store for my client. how is it done?
You do not need a Shopify Partner account for this. You can instead create a "Private application" within the normal shopify admin, which will give you the api credentials you need to make stuff happen.
This article on the shopify wiki gives a good overview of the process for getting started (the first sections are most relevant in your case):
http://wiki.shopify.com/Using_the_shopify_api_gem_with_the_credentials_of_a_private_app
I was asked to build a control-system for a Ebay-like Finnish auction-site huuto.net.
The system would reopen closed auctions by a specific rules. It would be completely external from the main site, running at an external website.
The site is however unwilling to release its API and Schema. I know no way to build such a system without knowing its API.
How do you build an internet site without its API and Schema?
You could try some form of automatic browsing: mechanize
Edit:
Examples here.
I think you're asking about building a site that interacts with another site without using a well-defined API. Is that right?
You can interact with an external site without using an official API - in order to do so, you need to imitate a normal site visitor and send your requests to the site frontend (in much the same way as a web crawler does). Tools like hpricot, mechanize and curl can help you parse the content of pages and send requests, but in doing so your system may be quite brittle. Any change to the target site might mean you have to rewrite portions of your system.
It might be possible to get the data you need by screen scraping the site. You could perform the operations you want to do by POSTing data into their forms or using a WebClient type API to make your program act like a web browser but that's likely to be an extremely brittle solution.
Honestly though, without an API, there really is no good solution.
you either need access to the database or an API, otherwise no point in even trying.