Provide API proxy docs
Please provide us with your API details, an overview for the developer portal, and the API monitoring information to help us effectively advertise your API across WPP.
tip
You can provide us with the necessary information through a Jira ticket.
API details
Use the CI/CD pipeline in the API First Developer Portal to provide us with the following API info:
- Title
- Description
- Your agency as a tag
- Field categories
- Image (900 x 500 px)
- Categories and tags
- OpenAPI spec (see Swagger Editor)
- Link to your API docs
Developer portal overview
Use the following template to provide us with the purpose of your API, authentication process, SLA, contact points, and payment model.
Purpose of your API
- What is the primary purpose of your API?
- What is the process that users should follow to access the necessary data?
- What functionality does your API offer?
- What is your intended target audience?
Authentication
- How can users access your API?
- Describe both the automatic and manual access methods.
SLA
- Call rate (quota)
- Service availability
- Security
- Performance
- Time to open an incident
- Time to repair the incident
Contact points
- Emergency, in case the API is non-responsive
- SLA/Sales, which users can contact with questions regarding the API business model (payment, SLAs, security, etc.)
- FAQs, to which users can refer with questions regarding the specifics of your API
Payment model
- What is your payment model?
- Do you provide different tiers? If yes, then describe the quota and costs for each tier.
- How often do you expect users to pay?
- Your billing information.
API monitoring info
Please provide this information based on the actual testing activities.
- Product owner
- Developer
- Proxy name
- Repository name
- Repository URL
- Health check API endpoint (GET request)
- SLAs that you expect to provide
- Contact points in case of accidents
- Monitoring rate (once per minute, 30 min, or an hour)