Home - esinyavsky/Content-API-V3-Documentation GitHub Wiki
Welcome to the Content API Developer's Guide!
About Content API 2
Content API allows you to search and download content using your own editorial tools, without having to visit our portals, such as apimages.com. The API provides access to:
- Images. AP-owned, member-owned and third-party images, including the full AP Images archive and the GraphicsBank collection.
- Video. AP-produced and select third-party video.
Important:
- Content available to you via the API depends on your plan. Please refer to contract information for details and contact your AP Sales or Licensing representative with any questions.
- If you currently access images via Content API and are interested in accessing video, please contact your AP Sales representative for more information.
Typical Workflow Overview
Work with your own editorial system. Your editors search and download AP Images and AP Video content using your own editorial tools:
- Run a search. When an editor performs a search in your editorial system, your custom program searches the AP Images or AP Video collection and displays search results along with key metadata. Content item pricing is available upon request.
- Pick a result to view metadata. When an editor selects a search result, your custom program retrieves full content metadata (optionally, with pricing) from the AP Content API system.
- Download content. When an editor wants to download an image or video file, your custom program downloads the requested content file from the AP Content API system.
- Review your account information. When an editor wants to check how many downloads available for your plan have already been used or download your order history, your custom program retrieves your plan and usage information or order history from AP Content API.
API Keys
An API key is the access key required for making API calls. If you have not received your API key, please contact Customer Support.
Supported Protocols
- HTTPS 1.1 is supported for the API calls to api.ap.org.
- HTTP 1.1 is supported for the API calls to bapi.ap.org.
Client Implementation Requirement
The implementation of your client application must allow new data elements and attributes to be added by AP by ignoring any markup that it does not recognize.
Recommended Practices
It is recommended that your client application download content item renditions or retrieve full metadata using the links returned in search results instead of constructing those links.
Note: This practice is also beneficial since the links returned in search results may contain additional optional parameters used for performance or troubleshooting.
Important: To receive pricing information in the Item Metadata method responses, make sure to add the showPricing=true parameter to the item metadata links along with the
apiKey
parameter.