- Usage Example
- Leading Practices
- Managing Items and Permissions
- Managing Security Identities in a Security Identity Provider
- Updating the Status of a Push Source
- Resetting a Push Source
- Creating a File Container
- Understanding the orderingId Parameter
- Understanding the API Processing Delay
- Troubleshooting API Error Codes
- API Reference
Push API Usage Overview
In general, using the Push API requires the following set up:
- Create a Push source (see Creating a Push Source).
- If your Push source is secured, create a security identity provider for it (see Creating a Security Identity Provider for a Secured Push Source).
In contrast with creating a standard source, creating a Push source never generates fields in your index as a side effect.
In contrast with a standard source, a new Push source does not include default mappings. However you should be aware that Push sources have a peculiar default behavior when it comes to populating fields with metadata values (see Understanding Push Source Item Metadata).
After this set up, you would use the Push API. In general this consists in writing code to regularly:
- Extract item data/metadata, and possibly permissions and security identities, from an original content repository.
- Add, update, and/or delete content as appropriate in your Push source and security identity provider using the Push API. See:
If you have never used the Push API before, a good way to get started is to go through the Push API Usage Example.