Linux 软件免费装

API Endpoints

开发者 meglio
更新时间 2015年8月14日 18:17
PHP版本: 3.6.1 及以上
WordPress版本: 4.2.3
版权: GPLv2
版权网址: 版权信息

标签

links integration ajax http api JSON CSV XML URL endpoint REST web service RESTful access point api access api client URI api endpoint Twig share data access data api format api output protected api api authentication cache api api interface http interface convert to api create api add api SOAP REST style api request api response api location api url api uri endpoint url multiple APIs JSON API XML API CSV API database API API from database http headers API headers api speed

下载

详情介绍:

Choose which of your site's data to make available via WordPress API and in which format. Features This is a free add-on to the Twig Anything WordPress plugin.

安装:

Minimum Requirements Automatic installation Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To do an automatic install of API Endpoints, log in to your WordPress dashboard, navigate to the Plugins menu and click Add New. In the search field type “API Endpoints” and click Search Plugins. Once you’ve found the plugin, you can view details about it such as the the point release, rating and description. Most importantly, of course, you can install it by simply clicking “Install Now”. Manual installation The manual installation method involves downloading the API Endpoints plugin and uploading it to your webserver via your favourite FTP application. The WordPress codex contains instructions on how to do this here. Updating Automatic updates should work like a charm; as always though, ensure you backup your site just in case.
  1. Upload twig-anything-api-endpoints.zip to the /wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress

屏幕截图:

  • The slick API Endpoints configuration panel with settings for error/success templates, URL names, capability roles set individually per API endpoint, and templates to use for each API.
  • HTTP headers configuration: by default, anti-cache headers are set, but you can add any headers depending on what format you want your API to output. It hints you about headers to use for most popular formats: JSON, XML, RSS and YAML.
  • An API endpoint in JSON format that gets information from a local CSV file and converts it into API.
  • Insufficient permissions when calling a protected API with a wrong username/password

升级注意事项:

1.1 This version adds a default HTTP Header that will allow ajax calls to your API Endpoints from domains other than your WordPress site. It also adds "Settings" and "Support" links to the plugins list for your convenience. This upgrade is not critical.

常见问题:

What formats can my API Endpoints output in?

JSON, XML, CSV (comma separated values), YAML and pretty much anything with just a bit of config. You have full control of what is output and which format.

How many API Endpoints can I create?

Create as many endpoints as you need. There are no limits!

Can I control access to my API Endpoints?

Yes, you can configure a minimum user role required for each endpoint separately. You will then pass username and password variables in your call to the API, which will be used to authenticate with your existing WordPress users.

Can I configure access to each API Endpoint separately?

Yes, every single API Endpoint has its own optional minimal role required to access the API.

Should I create a separate WordPress user to access API Endpoints?

If your API is public and meant to be accessed by anyone, then no. However, if you API needs authentication, then I recommend creating a separate WordPress user and using its username/password to access the API. A separate WP account for consuming your API would make it easier to switch it ON/OFF or change its permission level accordingly when required.

Can I configure the URL to my API?

By default, you would access your API endpoint by a URL like this: http://my-wordpress.com/api-endpoint/endpoint-name ... where api-endpoint is the common root URL, and endpoint-name is unique for every endpoint. Both of these pieces are configurable in the settings screen.

Can I control HTTP headers output by an API endpoint?

Yes, you can configure HTTP headers in the settings screen. To access it, click on the "Settings" menu and then on the "API Endpoints" sub-menu.

What if API returns an error?

As any API, yours can return an error. For example, if someone tries to access a protected API endpoint without appropriate authentication. If this is the case, the Error Template from the settings screen will be used. There is a default error template in JSON format in place, but you can easily tune it to your own needs.

How can I preview the API output?

In the Settings screen, in front of every api endpoint there is an "Open" button. Clicking on it opens a new tab in your browser linking to the URL the API. You can also use special tools to test you API, for example Postman.

Why does it require Twig Anything plugin?

Twig Anything is a super-powerful plugin that allows to fetch any data from anywhere and display it in your WordPress site. It is universal and extensible, and already has a lot of things like intelligent error handling and local cache. It also understands Twig syntax, which allows for endless applications and various scenarios. "API Endpoints" greatly benefits from all of this! Last but not least, the developer behind both plugins is the same :)

Can I turn a CSV file into an API?

Yes! You will need CSV Format add-on to read let it data from a CSV file.

Can I turn someone else's API into my own API?

Yes, just configure your Twig Template to fetch data from a URL and then output it either entirely or partially in your template.

更新日志:

1.1 1.0